PDI 1.4.0-alpha.2021-08-04.09fd084

the PDI data interface

context.h
1 /*******************************************************************************
2  * Copyright (C) 2015-2019 Commissariat a l'energie atomique et aux energies alternatives (CEA)
3  * Copyright (C) 2021 Institute of Bioorganic Chemistry Polish Academy of Science (PSNC)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of CEA nor the names of its contributors may be used to
14  * endorse or promote products derived from this software without specific
15  * prior written permission.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23  * THE SOFTWARE.
24  ******************************************************************************/
25 
26 #ifndef PDI_CONTEXT_H_
27 #define PDI_CONTEXT_H_
28 
29 #include <functional>
30 #include <memory>
31 #include <string>
32 #include <unordered_map>
33 
34 #include <pdi/pdi_fwd.h>
35 #include <pdi/callbacks.h>
36 #include <pdi/data_descriptor.h>
37 #include <pdi/datatype_template.h>
38 #include <pdi/logger.h>
39 #include <pdi/ref_any.h>
40 
41 
42 namespace PDI {
43 
44 class PDI_EXPORT Context
45 {
46 public:
49  class Iterator
50  {
51  friend class Context;
53  std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator m_data;
54  Iterator(const std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator& data);
55  Iterator(std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator&& data);
56  public:
57  Data_descriptor* operator-> ();
58  Data_descriptor& operator* ();
59  Iterator& operator++ ();
60  bool operator!= (const Iterator&);
61  };
62 
65  typedef std::function<Datatype_template_uptr(Context&, PC_tree_t)> Datatype_template_parser;
66 
67 protected:
68  Iterator get_iterator(const std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator& data);
69 
70  Iterator get_iterator(std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator&& data);
71 
72 public:
73  virtual ~Context();
74 
77  virtual Data_descriptor& desc(const std::string& name) = 0;
78 
81  virtual Data_descriptor& desc(const char* name) = 0;
82 
85  virtual Data_descriptor& operator[](const std::string& name) = 0;
86 
89  virtual Data_descriptor& operator[](const char* name) = 0;
90 
93  virtual Iterator begin() = 0;
94 
97  virtual Iterator end() = 0;
98 
102  virtual void event(const char* name) = 0;
103 
107  virtual Logger& logger() = 0;
108 
112  virtual Callbacks& callbacks() = 0;
113 
119  virtual Datatype_template_uptr datatype(PC_tree_t node) = 0;
120 
126  virtual void add_datatype(const std::string& name, Datatype_template_parser parser) = 0;
127 
129  virtual void finalize_and_exit() = 0;
130 };
131 
132 } // namespace PDI
133 
134 #endif // PDI_CONTEXT_H_
Definition: context.h:44
Wrapper for spdlog::logger with additional pattern getter method.
Definition: logger.h:41
std::unique_ptr< Datatype_template > Datatype_template_uptr
Definition: pdi_fwd.h:70
Definition: callbacks.h:38
Definition: data_descriptor.h:39
An iterator used to go through the descriptor store.
Definition: context.h:49
Definition: array_datatype.h:37
std::function< Datatype_template_uptr(Context &, PC_tree_t)> Datatype_template_parser
A function that parses a PC_tree_t to create a datatype_template.
Definition: context.h:65