LoopProjectFile-cpp/LoopProjectFileUtils.h at master · Loop3D/LoopProjectFile-cpp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#ifndef __LOOPPROJECTFILEUTILS_H
#define __LOOPPROJECTFILEUTILS_H

#include <string>

#define LOOP_NAME_LENGTH 120
#define LOOP_GROUP_NAME_LENGTH 120
#define LOOP_SUPERGROUP_NAME_LENGTH 120
#define LOOP_CONFIGURATION_DEFAULT_STRING_LENGTH 120

#ifdef __linux__
#define strncpy_s strncpy
#endif

/*! \brief A structure for returning an error code and message for loop project files */
struct LoopProjectFileResponse
{
    int errorCode;            /**< Error Code:- \n 0 - *No error* \n 1 - *Error* */
    std::string errorMessage; /**< Error message string to print/return */
};

namespace LoopProjectFile
{

    /*!
     * \brief Utility function to create a Loop Project File Response
     *
     * \param errorCode - the error code to add
     * \param errorMsg - the error message to add and opinionally print
     * \param echo - a flag to toggle printing message to standard out
     *
     * \return The created Loop Project File Response with error code and message
     */
    LoopProjectFileResponse createErrorMsg(int errorCode, std::string errorMsg, bool echo = true);

}; // namespace LoopProjectFile

#endif