error_handling.h

Go to the documentation of this file.

// Copyright 2014 Open Source Robotics Foundation, 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 RMW__ERROR_HANDLING_H_
#define RMW__ERROR_HANDLING_H_

#if __cplusplus
extern "C"
{
#endif

#include <stdbool.h>
#include <stddef.h>

#include "rmw/macros.h"
#include "rmw/visibility_control.h"

typedef struct rmw_error_state_t
{
  const char * message;
  const char * file;
  size_t line_number;
} rmw_error_state_t;


RMW_PUBLIC
void
rmw_set_error_state(const char * error_msg, const char * file, size_t line_number);


#define RMW_SET_ERROR_MSG(msg) rmw_set_error_state(msg, __FILE__, __LINE__);

RMW_PUBLIC
bool
rmw_error_is_set(void);


RMW_PUBLIC
const rmw_error_state_t *
rmw_get_error_state(void);


RMW_PUBLIC
const char *
rmw_get_error_string(void);


RMW_PUBLIC
const char *
rmw_get_error_string_safe(void);

RMW_PUBLIC
void
rmw_reset_error(void);

#if __cplusplus
}
#endif

#endif  // RMW__ERROR_HANDLING_H_