All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
regTest.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef TF_REGTEST_H
25 #define TF_REGTEST_H
26 
30 
31 #include "pxr/pxr.h"
32 
33 #include "pxr/base/tf/api.h"
34 #include "pxr/base/tf/singleton.h"
35 #include "pxr/base/tf/hash.h"
36 #include "pxr/base/tf/hashmap.h"
37 #include <string>
38 
39 PXR_NAMESPACE_OPEN_SCOPE
40 
89 class TfRegTest {
90 public:
106  static int Main(int argc, char *argv[]) {
107  return GetInstance()._Main(argc, argv);
108  }
109 
110  TF_API
111  static TfRegTest& GetInstance();
112 
114  typedef bool (*RegFunc)();
115 
121  typedef bool (*RegFuncWithArgs)(int argc, char *argv[]);
122 
123  TF_API
124  bool Register(const char* name, RegFunc);
125  TF_API
126  bool Register(const char* name, RegFuncWithArgs);
127 
128 private:
129  friend class TfSingleton<TfRegTest>;
130  TF_API
131  int _Main(int argc, char *argv[]);
132 
133  void _PrintTestNames();
134 
135  typedef TfHashMap<std::string, RegFunc, TfHash> _Hash;
136  typedef TfHashMap<std::string, RegFuncWithArgs, TfHash> _HashWithArgs;
137  _Hash _functionTable;
138  _HashWithArgs _functionTableWithArgs;
139 };
140 
141 TF_API_TEMPLATE_CLASS(TfSingleton<TfRegTest>);
142 
149 #define TF_ADD_REGTEST(name) \
150  bool Tf_RegTst##name = TfRegTest::GetInstance().Register(#name, Test_##name)
151 
152 PXR_NAMESPACE_CLOSE_SCOPE
153 
154 #endif
Manage a single instance of an object (see.
Definition: singleton.h:122
bool(* RegFunc)()
Type of a function with no arguments.
Definition: regTest.h:114
TfRegTest is a singleton class, which is used to register functions with either type bool (*)(int...
Definition: regTest.h:89
bool(* RegFuncWithArgs)(int argc, char *argv[])
Type of a function with arguments.
Definition: regTest.h:121
static int Main(int argc, char *argv[])
Run a single regression test function, returning 0 if the function succeeded and 1 otherwise...
Definition: regTest.h:106