annotate Core/Toolbox.h @ 3640:94f4a18a79cc

upgrade to year 2020
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 31 Jan 2020 17:14:59 +0100
parents 962e5f00744b
children f6a73611ec5c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
59
c996319e90bc renaming in Core
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 50
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1833
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1103
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
136
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
11 *
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
12 * In addition, as a special exception, the copyright holders of this
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
13 * program give permission to link the code of its release with the
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
16 * the linked executables. You must obey the GNU General Public License
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
20 * you do not wish to do so, delete this exception statement from your
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
21 * version. If you delete this exception statement from all source files
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 107
diff changeset
22 * in the program, then also delete it here.
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
453
30086c1aca30 endianness
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 402
diff changeset
36 #include "Enumerations.h"
30086c1aca30 endianness
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 402
diff changeset
37
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #include <stdint.h>
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 #include <vector>
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 #include <string>
1045
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
41 #include <json/json.h>
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
2137
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
43
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
44 #if !defined(ORTHANC_ENABLE_BASE64)
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
45 # error The macro ORTHANC_ENABLE_BASE64 must be defined
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
46 #endif
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
47
2367
2aff870c2c58 refactoring of BoostConfiguration.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2330
diff changeset
48 #if !defined(ORTHANC_ENABLE_LOCALE)
2aff870c2c58 refactoring of BoostConfiguration.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2330
diff changeset
49 # error The macro ORTHANC_ENABLE_LOCALE must be defined
2aff870c2c58 refactoring of BoostConfiguration.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2330
diff changeset
50 #endif
2aff870c2c58 refactoring of BoostConfiguration.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2330
diff changeset
51
2137
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
52 #if !defined(ORTHANC_ENABLE_MD5)
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
53 # error The macro ORTHANC_ENABLE_MD5 must be defined
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
54 #endif
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
55
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
56 #if !defined(ORTHANC_ENABLE_PUGIXML)
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
57 # error The macro ORTHANC_ENABLE_PUGIXML must be defined
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
58 #endif
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
59
2141
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
60
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
61 /**
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
62 * NOTE: GUID vs. UUID
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
63 * The simple answer is: no difference, they are the same thing. Treat
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
64 * them as a 16 byte (128 bits) value that is used as a unique
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
65 * value. In Microsoft-speak they are called GUIDs, but call them
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
66 * UUIDs when not using Microsoft-speak.
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
67 * http://stackoverflow.com/questions/246930/is-there-any-difference-between-a-guid-and-a-uuid
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
68 **/
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
69
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
70
3203
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
71 #if ORTHANC_ENABLE_PUGIXML == 1
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
72 # include <pugixml.hpp>
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
73 #endif
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
74
2141
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
75
59
c996319e90bc renaming in Core
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 50
diff changeset
76 namespace Orthanc
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 {
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 typedef std::vector<std::string> UriComponents;
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
284
06aa7b7b6723 implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 247
diff changeset
80 class NullType
06aa7b7b6723 implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 247
diff changeset
81 {
06aa7b7b6723 implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 247
diff changeset
82 };
06aa7b7b6723 implementation of a single-threaded cache mechanism
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 247
diff changeset
83
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 namespace Toolbox
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 {
2513
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
86 class LinesIterator
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
87 {
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
88 private:
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
89 const std::string& content_;
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
90 size_t lineStart_;
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
91 size_t lineEnd_;
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
92
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
93 void FindEndOfLine();
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
94
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
95 public:
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
96 LinesIterator(const std::string& content);
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
97
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
98 bool GetLine(std::string& target) const;
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
99
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
100 void Next();
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
101 };
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
102
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
103
690
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
104 void ToUpperCase(std::string& s); // Inplace version
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
105
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
106 void ToLowerCase(std::string& s); // Inplace version
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107
690
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
108 void ToUpperCase(std::string& result,
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
109 const std::string& source);
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
110
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
111 void ToLowerCase(std::string& result,
2e67366aab83 case-insensitive matching of Application Entity Titles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
112 const std::string& source);
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 void SplitUriComponents(UriComponents& components,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 const std::string& uri);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116
966
886652370ff2 accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 949
diff changeset
117 void TruncateUri(UriComponents& target,
886652370ff2 accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 949
diff changeset
118 const UriComponents& source,
886652370ff2 accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 949
diff changeset
119 size_t fromLevel);
886652370ff2 accelerating REST API matching
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 949
diff changeset
120
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 bool IsChildUri(const UriComponents& baseUri,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 const UriComponents& testedUri);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 std::string FlattenUri(const UriComponents& components,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 size_t fromLevel = 0);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126
2137
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
127 #if ORTHANC_ENABLE_MD5 == 1
22
1bc6327d1de3 MD5 sum
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
128 void ComputeMD5(std::string& result,
1bc6327d1de3 MD5 sum
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
129 const std::string& data);
24
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 22
diff changeset
130
693
01d8611c4a60 md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
131 void ComputeMD5(std::string& result,
01d8611c4a60 md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
132 const void* data,
1833
47d032c48818 "OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1818
diff changeset
133 size_t size);
1479
8f28a1cd2354 possibility to disable md5 and base64 support in the toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1446
diff changeset
134 #endif
693
01d8611c4a60 md5 for attached files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 690
diff changeset
135
177
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
136 void ComputeSHA1(std::string& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
137 const std::string& data);
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 136
diff changeset
138
1833
47d032c48818 "OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1818
diff changeset
139 void ComputeSHA1(std::string& result,
47d032c48818 "OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1818
diff changeset
140 const void* data,
47d032c48818 "OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1818
diff changeset
141 size_t size);
47d032c48818 "OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1818
diff changeset
142
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3322
diff changeset
143 bool IsSHA1(const void* str,
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1430
diff changeset
144 size_t size);
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1430
diff changeset
145
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1430
diff changeset
146 bool IsSHA1(const std::string& s);
402
d2c69150a979 bulk storescu
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 398
diff changeset
147
2137
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
148 #if ORTHANC_ENABLE_BASE64 == 1
809
8ce2f69436ca do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 803
diff changeset
149 void DecodeBase64(std::string& result,
8ce2f69436ca do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 803
diff changeset
150 const std::string& data);
365
cda6938a8c6f decode base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 336
diff changeset
151
809
8ce2f69436ca do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 803
diff changeset
152 void EncodeBase64(std::string& result,
8ce2f69436ca do not return strings with base64
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 803
diff changeset
153 const std::string& data);
1648
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
154
1981
4b545a8b1f95 return code in Toolbox::DecodeDataUriScheme
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1933
diff changeset
155 bool DecodeDataUriScheme(std::string& mime,
1648
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
156 std::string& content,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
157 const std::string& source);
1818
1065401501fb ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1648
diff changeset
158
1065401501fb ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1648
diff changeset
159 void EncodeDataUriScheme(std::string& result,
1065401501fb ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1648
diff changeset
160 const std::string& mime,
1065401501fb ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1648
diff changeset
161 const std::string& content);
1479
8f28a1cd2354 possibility to disable md5 and base64 support in the toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1446
diff changeset
162 #endif
87
8517e2c44283 path to configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 59
diff changeset
163
2367
2aff870c2c58 refactoring of BoostConfiguration.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2330
diff changeset
164 #if ORTHANC_ENABLE_LOCALE == 1
107
3b45473c0a73 replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 87
diff changeset
165 std::string ConvertToUtf8(const std::string& source,
3217
cf8cbeb35f33 preliminary support of Korean character set
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3203
diff changeset
166 Encoding sourceEncoding,
cf8cbeb35f33 preliminary support of Korean character set
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3203
diff changeset
167 bool hasCodeExtensions);
1557
ad1e127b4ed5 fix in encodings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1555
diff changeset
168
ad1e127b4ed5 fix in encodings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1555
diff changeset
169 std::string ConvertFromUtf8(const std::string& source,
ad1e127b4ed5 fix in encodings
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1555
diff changeset
170 Encoding targetEncoding);
2367
2aff870c2c58 refactoring of BoostConfiguration.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2330
diff changeset
171 #endif
107
3b45473c0a73 replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 87
diff changeset
172
2129
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2077
diff changeset
173 bool IsAsciiString(const void* data,
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2077
diff changeset
174 size_t size);
0c09d1af22f3 "/tools/invalidate-tags" to invalidate the JSON summary of all the DICOM files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2077
diff changeset
175
2442
330349d712f9 fix Toolbox::IsAsciiString
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2373
diff changeset
176 bool IsAsciiString(const std::string& s);
330349d712f9 fix Toolbox::IsAsciiString
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2373
diff changeset
177
107
3b45473c0a73 replace boost::locale with iconv for debian
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 87
diff changeset
178 std::string ConvertToAscii(const std::string& source);
187
8e673a65564d refactoring of storing new instances
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 177
diff changeset
179
247
c9b3ba0fd140 path management in zip files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 187
diff changeset
180 std::string StripSpaces(const std::string& source);
c9b3ba0fd140 path management in zip files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 187
diff changeset
181
336
3c291753231f url decode
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 284
diff changeset
182 // In-place percent-decoding for URL
3c291753231f url decode
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 284
diff changeset
183 void UrlDecode(std::string& s);
453
30086c1aca30 endianness
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 402
diff changeset
184
30086c1aca30 endianness
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 402
diff changeset
185 Endianness DetectEndianness();
608
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
186
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
187 std::string WildcardToRegularExpression(const std::string& s);
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
188
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
189 void TokenizeString(std::vector<std::string>& result,
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
190 const std::string& source,
0bedf8ff9288 basic find scp
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 483
diff changeset
191 char separator);
800
ecedd89055db generation of DICOM images from PNG files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 707
diff changeset
192
2136
dd609a99d39a uniformization of the macro naming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2129
diff changeset
193 #if ORTHANC_ENABLE_PUGIXML == 1
1045
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
194 void JsonToXml(std::string& target,
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
195 const Json::Value& source,
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
196 const std::string& rootElement = "root",
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
197 const std::string& arrayElement = "item");
0bfeeb6d340f json to xml conversion with pugixml
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 971
diff changeset
198 #endif
1050
64f1842aae2e Toolbox::ExecuteSystemCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1045
diff changeset
199
3203
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
200 #if ORTHANC_ENABLE_PUGIXML == 1
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
201 void XmlToString(std::string& target,
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
202 const pugi::xml_document& source);
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
203 #endif
810772486249 URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
204
1102
ce6386b37afd avoid unnecessary exceptions on Orthanc startup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1101
diff changeset
205 bool IsInteger(const std::string& str);
1424
fe384a9d3b51 OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1397
diff changeset
206
fe384a9d3b51 OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1397
diff changeset
207 void CopyJsonWithoutComments(Json::Value& target,
fe384a9d3b51 OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1397
diff changeset
208 const Json::Value& source);
1430
ad94a3583b07 Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
209
ad94a3583b07 Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
210 bool StartsWith(const std::string& str,
ad94a3583b07 Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
211 const std::string& prefix);
1490
596927722403 support of --logdir by the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1479
diff changeset
212
2043
35ccba7adae9 Toolbox::UriEncode
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2017
diff changeset
213 void UriEncode(std::string& target,
35ccba7adae9 Toolbox::UriEncode
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2017
diff changeset
214 const std::string& source);
2071
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
215
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
216 std::string GetJsonStringField(const ::Json::Value& json,
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
217 const std::string& key,
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
218 const std::string& defaultValue);
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
219
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
220 bool GetJsonBooleanField(const ::Json::Value& json,
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
221 const std::string& key,
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
222 bool defaultValue);
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
223
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
224 int GetJsonIntegerField(const ::Json::Value& json,
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
225 const std::string& key,
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
226 int defaultValue);
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
227
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
228 unsigned int GetJsonUnsignedIntegerField(const ::Json::Value& json,
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
229 const std::string& key,
27fd34970c52 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2065
diff changeset
230 unsigned int defaultValue);
2141
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
231
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
232 bool IsUuid(const std::string& str);
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
233
a260a8ad83f1 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2140
diff changeset
234 bool StartsWithUuid(const std::string& str);
2326
423d3b692bb9 Upgrade to Boost 1.64.0, and Toolbox::ToUpperCaseWithAccents
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
235
2367
2aff870c2c58 refactoring of BoostConfiguration.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2330
diff changeset
236 #if ORTHANC_ENABLE_LOCALE == 1
2330
9c7a80c87ae9 "Locale" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2326
diff changeset
237 void InitializeGlobalLocale(const char* locale);
2326
423d3b692bb9 Upgrade to Boost 1.64.0, and Toolbox::ToUpperCaseWithAccents
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
238
423d3b692bb9 Upgrade to Boost 1.64.0, and Toolbox::ToUpperCaseWithAccents
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
239 void FinalizeGlobalLocale();
423d3b692bb9 Upgrade to Boost 1.64.0, and Toolbox::ToUpperCaseWithAccents
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
240
423d3b692bb9 Upgrade to Boost 1.64.0, and Toolbox::ToUpperCaseWithAccents
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
241 std::string ToUpperCaseWithAccents(const std::string& source);
2373
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2367
diff changeset
242 #endif
2512
4dcafa8d6633 SystemToolbox::GenerateUuid moved to Toolbox::GenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
243
2677
0196d07a900f migrate OpenSSL initialization to Toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2513
diff changeset
244 void InitializeOpenSsl();
0196d07a900f migrate OpenSSL initialization to Toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2513
diff changeset
245
0196d07a900f migrate OpenSSL initialization to Toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2513
diff changeset
246 void FinalizeOpenSsl();
0196d07a900f migrate OpenSSL initialization to Toolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2513
diff changeset
247
2512
4dcafa8d6633 SystemToolbox::GenerateUuid moved to Toolbox::GenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
248 std::string GenerateUuid();
2920
ad0e7def3338 Toolbox::SubstituteVariables and SystemToolbox::GetEnvironmentVariables
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2906
diff changeset
249
ad0e7def3338 Toolbox::SubstituteVariables and SystemToolbox::GetEnvironmentVariables
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2906
diff changeset
250 std::string SubstituteVariables(const std::string& source,
ad0e7def3338 Toolbox::SubstituteVariables and SystemToolbox::GetEnvironmentVariables
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2906
diff changeset
251 const std::map<std::string, std::string>& dictionary);
3217
cf8cbeb35f33 preliminary support of Korean character set
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3203
diff changeset
252
cf8cbeb35f33 preliminary support of Korean character set
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3203
diff changeset
253 void RemoveIso2022EscapeSequences(std::string& dest,
cf8cbeb35f33 preliminary support of Korean character set
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3203
diff changeset
254 const std::string& src);
3322
b32b7c44a223 Toolbox::Utf8ToUnicodeCharacter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3217
diff changeset
255
b32b7c44a223 Toolbox::Utf8ToUnicodeCharacter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3217
diff changeset
256 void Utf8ToUnicodeCharacter(uint32_t& unicode,
b32b7c44a223 Toolbox::Utf8ToUnicodeCharacter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3217
diff changeset
257 size_t& utf8Length,
b32b7c44a223 Toolbox::Utf8ToUnicodeCharacter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3217
diff changeset
258 const std::string& utf8,
b32b7c44a223 Toolbox::Utf8ToUnicodeCharacter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3217
diff changeset
259 size_t position);
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
260 }
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
261 }
2513
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
262
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
263
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
264
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
265
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
266 /**
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
267 * The plain C, opaque data structure "OrthancLinesIterator" is a thin
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
268 * wrapper around Orthanc::Toolbox::LinesIterator, and is only used by
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
269 * "../Resources/WebAssembly/dcdict.cc", in order to avoid code
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
270 * duplication
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
271 **/
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
272
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
273 struct OrthancLinesIterator;
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
274
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
275 OrthancLinesIterator* OrthancLinesIterator_Create(const std::string& content);
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
276
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
277 bool OrthancLinesIterator_GetLine(std::string& target,
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
278 const OrthancLinesIterator* iterator);
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
279
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
280 void OrthancLinesIterator_Next(OrthancLinesIterator* iterator);
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
281
97a74f0eac7a loading DICOM dictionaries in sandboxed environments
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2512
diff changeset
282 void OrthancLinesIterator_Free(OrthancLinesIterator* iterator);