summaryrefslogtreecommitdiff
path: root/libs/misc/include/misc/environment.h
blob: 8e6bd00d5bd422f0efaf18ad7328ccb5c9e7450c (plain)
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * 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.
 */

/**
 * @file environment.h
 * @ingroup COM_AI_RUNTIME
 * @brief This file contains utility functions and classes to access environment variables
 */

#ifndef __UTIL_ENVIRONMENT_H__
#define __UTIL_ENVIRONMENT_H__

namespace nnfw
{
namespace misc
{

/**
 * @brief Get the environment variable of int type
 * @param[in] name            Name of the environment variable
 * @param[in] defaultValue    Default value when the value of environment variable does not exist
 * @return  The int value of the environment variable
 */
int get_env_int(const char *name, int defaultValue = 0);

/**
 * @brief Get the environment variable of bool type
 * @param[in] name            Name of the environment variable
 * @param[in] defaultValue    Default value when the value of environment variable does not exist
 * @return  @c 0 if the value of the environment variable is @c "0", @c 1 in case of other number
 */
bool get_env_bool(const char *name, bool defaultValue = false);
}
}

#include <string>

namespace nnfw
{
namespace misc
{
namespace env
{
/**
 * @brief Parent struct of @ref IntAccessor and @ref FloatAccessor
 * @tparam T Type of the value of environment variable
 */
template <typename T> struct Accessor
{
  /**
   * @brief Destroy the Accessor object
   */
  virtual ~Accessor() = default;
  /**
   * @brief Read the value of environment variable
   * @param[out] out    The value of environment variable
   * @return     @c true if accessing environment variable is successful,
   *             @c false if there is exist no such environment variable
   */
  virtual bool access(T &out) const = 0;
};

/**
 * @brief Class to read int environment variable
 */
class IntAccessor : public Accessor<int>
{
public:
  /**
   * @brief Construct a new IntAccessor object
   * @param[in] tag     Name of environment variable
   */
  IntAccessor(const std::string &tag);

public:
  /**
   * @brief Read the value of environment variable
   * @param[out] out    The value of environment variable
   * @return     @c true if accessing environment variable is successful,
   *             @c false if there is exist no such environment variable
   */
  bool access(int &out) const override;

private:
  std::string _tag;
};

/**
 * @brief Class to read float environment variable
 */
class FloatAccessor : public Accessor<float>
{
public:
  /**
   * @brief Construct a new FloatAccessor object
   * @param[in] tag     Name of environment variable
   */
  FloatAccessor(const std::string &tag);

public:
  /**
   * @brief Read the value of environment variable
   * @param[out] out    The value of environment variable
   * @return     @c true if accessing environment variable is successful,
   *             @c false if there is exist no such environment variable
   */
  bool access(float &out) const override;

private:
  std::string _tag;
};

} // namespace env
} // namespace misc
} // namespace nnfw

#endif // __UTIL_ENVIRONMENT_H__