xlnt
ext_list.hpp
1 // Copyright (c) 2014-2022 Thomas Fussell
2 // Copyright (c) 2024 xlnt-community
3 //
4 // Permission is hereby granted, free of charge, to any person obtaining a copy
5 // of this software and associated documentation files (the "Software"), to deal
6 // in the Software without restriction, including without limitation the rights
7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 // copies of the Software, and to permit persons to whom the Software is
9 // furnished to do so, subject to the following conditions:
10 //
11 // The above copyright notice and this permission notice shall be included in
12 // all copies or substantial portions of the Software.
13 //
14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 // THE SOFTWARE
21 //
22 // @license: http://www.opensource.org/licenses/mit-license.php
23 // @author: see AUTHORS file
24 
25 #pragma once
26 
27 #include <xlnt/xlnt_config.hpp>
28 #include <xlnt/packaging/uri.hpp>
29 
30 #include <string>
31 #include <vector>
32 
33 namespace xml {
34 class parser;
35 class serializer;
36 } // namespace xml
37 
38 namespace xlnt {
39 
45 class XLNT_API ext_list
46 {
47 public:
48  struct ext
49  {
50  ext(xml::parser &parser, const std::string &ns);
51  ext(const uri &ID, const std::string &serialised);
52  void serialise(xml::serializer &serialiser, const std::string &ns);
53 
54  uri extension_ID_;
55  std::string serialised_value_;
56  };
57  ext_list() = default; // default ctor required by xlnt::optional
58  explicit ext_list(xml::parser &parser, const std::string &ns);
59  void serialize(xml::serializer &serialiser, const std::string &ns);
60 
61  void add_extension(const uri &ID, const std::string &element);
62 
63  bool has_extension(const uri &extension_uri) const;
64 
65  const ext &extension(const uri &extension_uri) const;
66 
67  const std::vector<ext> &extensions() const;
68 
69  bool operator==(const ext_list &rhs) const;
70 
71 private:
72  std::vector<ext> extensions_;
73 };
74 
75 inline bool operator==(const ext_list::ext &lhs, const ext_list::ext &rhs)
76 {
77  return lhs.extension_ID_ == rhs.extension_ID_
78  && lhs.serialised_value_ == rhs.serialised_value_;
79 }
80 } // namespace xlnt
Enumerates the possible types a cell can be determined by it&#39;s current value.
Definition: cell.hpp:37
Encapsulates a uniform resource identifier (URI) as described by RFC 3986.
Definition: uri.hpp:38
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
Definition: spreadsheet_drawing.hpp:31
Definition: ext_list.hpp:48
A list of xml extensions that may or may not be understood by the parser preservation is required for...
Definition: ext_list.hpp:45