.. _program_listing_file_include_rcl_yaml_param_parser_parser.h:

Program Listing for File parser.h
=================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_rcl_yaml_param_parser_parser.h>` (``include/rcl_yaml_param_parser/parser.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // Copyright 2018 Apex.AI, Inc.
   //
   // Licensed under the Apache License, Version 2.0 (the "License");
   // you may not use this file except in compliance with the License.
   // You may obtain a copy of the License at
   //
   //     http://www.apache.org/licenses/LICENSE-2.0
   //
   // Unless required by applicable law or agreed to in writing, software
   // distributed under the License is distributed on an "AS IS" BASIS,
   // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   // See the License for the specific language governing permissions and
   // limitations under the License.
   
   #ifndef RCL_YAML_PARAM_PARSER__PARSER_H_
   #define RCL_YAML_PARAM_PARSER__PARSER_H_
   
   #include <stdlib.h>
   
   #include "rcl_yaml_param_parser/types.h"
   #include "rcl_yaml_param_parser/visibility_control.h"
   
   #include "rcutils/allocator.h"
   #include "rcutils/types/rcutils_ret.h"
   
   #ifdef __cplusplus
   extern "C"
   {
   #endif
   
   RCL_YAML_PARAM_PARSER_PUBLIC
   rcl_params_t * rcl_yaml_node_struct_init(
     const rcutils_allocator_t allocator);
   
   RCL_YAML_PARAM_PARSER_PUBLIC
   rcl_params_t * rcl_yaml_node_struct_init_with_capacity(
     size_t capacity,
     const rcutils_allocator_t allocator);
   
   RCL_YAML_PARAM_PARSER_PUBLIC
   rcutils_ret_t rcl_yaml_node_struct_reallocate(
     rcl_params_t * params_st,
     size_t new_capacity,
     const rcutils_allocator_t allocator);
   
   RCL_YAML_PARAM_PARSER_PUBLIC
   rcl_params_t * rcl_yaml_node_struct_copy(
     const rcl_params_t * params_st);
   
   RCL_YAML_PARAM_PARSER_PUBLIC
   void rcl_yaml_node_struct_fini(
     rcl_params_t * params_st);
   
   RCL_YAML_PARAM_PARSER_PUBLIC
   bool rcl_parse_yaml_file(
     const char * file_path,
     rcl_params_t * params_st);
   
   RCL_YAML_PARAM_PARSER_PUBLIC
   bool rcl_parse_yaml_value(
     const char * node_name,
     const char * param_name,
     const char * yaml_value,
     rcl_params_t * params_st);
   
   RCL_YAML_PARAM_PARSER_PUBLIC
   rcl_variant_t * rcl_yaml_node_struct_get(
     const char * node_name,
     const char * param_name,
     rcl_params_t * params_st);
   
   RCL_YAML_PARAM_PARSER_PUBLIC
   void rcl_yaml_node_struct_print(
     const rcl_params_t * const params_st);
   
   #ifdef __cplusplus
   }
   #endif
   
   #endif  // RCL_YAML_PARAM_PARSER__PARSER_H_