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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* Copyright (C) 2005-2017 Centre National d'Etudes Spatiales (CNES)
*
* This file is part of Orfeo Toolbox
*
* https://www.orfeo-toolbox.org/
*
* 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.
*/
#if defined(_MSC_VER)
#pragma warning ( disable : 4786 )
#endif
#include "otbWrapperApplicationRegistry.h"
using otb::Wrapper::Application;
using otb::Wrapper::ApplicationRegistry;
typedef std::pair<std::string,std::string> DocElement;
bool CheckNonEmpty(const DocElement & elem)
{
bool ret = true;
if (elem.second == "")
{
std::cout << " /!\\ Missing "<< elem.first << std::endl;
ret = false;
}
return ret;
}
bool CheckMinimumSize(const DocElement & elem, unsigned int size)
{
bool ret = true;
if (elem.second.size() < size)
{
std::cout<<" /!\\ " << elem.first <<" too small..."<<std::endl;
ret = false;
}
return ret;
}
bool CheckNoNewline(const DocElement & elem)
{
bool ret = true;
if (elem.second.find('\n') != std::string::npos)
{
std::cout << " /!\\ "<< elem.first << " should not contain newlines"<<std::endl;
ret = false;
}
return ret;
}
bool CheckNoTrailingNewline(const DocElement & elem)
{
bool ret = true;
std::string whitespace(" \t\f\v\r");
size_t pos = elem.second.find_last_not_of(whitespace);
if (pos != std::string::npos && elem.second.at(pos) == '\n')
{
std::cout << " /!\\ "<< elem.first << " should not end with a newline" << std::endl;
ret = false;
}
return ret;
}
bool CheckMultiline(const DocElement & elem)
{
bool ret = true;
std::string whitespace(" \t\f\v\r");
size_t pos = elem.second.find('\n');
size_t lastPos = elem.second.find_last_not_of(whitespace);
if (pos == std::string::npos || pos == lastPos)
{
std::cout << " /!\\ "<< elem.first << " should not be a single line" << std::endl;
ret = false;
}
return ret;
}
int otbWrapperApplicationDocTest(int argc, char* argv[])
{
if (argc < 2)
{
std::cerr << "Usage : " << argv[0] << " [MODULEPATH]" << std::endl;
return EXIT_FAILURE;
}
// Get the module path list
std::list<std::string> modulePathList;
if (argc > 1)
{
std::copy(argv + 1, argv + argc, std::back_inserter(modulePathList));
// Load the path in the environment
std::list<std::string>::const_iterator it = modulePathList.begin();
while( it != modulePathList.end() )
{
ApplicationRegistry::AddApplicationPath( *(it) );
++it;
}
}
bool isOK = true;
// Get list of available applications
std::vector<std::string> list = ApplicationRegistry::GetAvailableApplications();
for (std::vector<std::string>::const_iterator it = list.begin(); it != list.end(); ++it)
{
std::cout << "Testing documentation for application "<< (*it) << " ..." << std::endl;
// Create module
Application::Pointer app = ApplicationRegistry::CreateApplication(*it);
// Check application availability
if( app.IsNull() )
{
std::cout<<"Unable to load "<<argv[1]<<" application."<<std::endl;
isOK = false;
continue;
}
// Check doc element...
DocElement name("Name",app->GetName());
DocElement docName("Doc Name",app->GetDocName());
DocElement description("Description",app->GetDescription());
DocElement longDescription("Long description",app->GetDocLongDescription());
DocElement authors("DocAuthors",app->GetDocAuthors());
DocElement limitations("DocLimitations",app->GetDocLimitations());
DocElement seeAlso("DocSeeAlso",app->GetDocSeeAlso());
isOK = CheckNonEmpty(name) && isOK;
isOK = CheckNoNewline(name) && isOK;
isOK = CheckNonEmpty(docName) && isOK;
isOK = CheckNoNewline(docName) && isOK;
isOK = CheckNonEmpty(description) && isOK;
isOK = CheckNonEmpty(longDescription) && isOK;
isOK = CheckMinimumSize(longDescription,30) && isOK;
isOK = CheckNoTrailingNewline(longDescription) && isOK;
//isOK = CheckMultiline(longDescription) && isOK;
isOK = CheckNonEmpty(authors) && isOK;
isOK = CheckNonEmpty(limitations) && isOK;
isOK = CheckNonEmpty(seeAlso) && isOK;
// TODO : check format of SeeAlso section
if( app->GetDocTags().size() == 0 )
{
std::cout<<"Missing DocTags."<<std::endl;
isOK = false;
}
// Check example data
app->Init();
otb::Wrapper::DocExampleStructure::Pointer doc = app->GetDocExample();
if( doc->GetApplicationName() == "" )
{
std::cout<<"Error in doc example: no aaplication name found."<<std::endl;
isOK = false;
}
if( doc->GetParameterList().size() == 0 )
{
std::cout<<"Error in doc example: the list of parameter is empty."<<std::endl;
isOK = false;
}
else
{
bool hasValue = false;
unsigned int count = 0;
while ( count<doc->GetParameterList().size() && !hasValue )
{
if( doc->GetParameterValue(count) != "" )
{
hasValue = true;
}
count++;
}
if( !hasValue )
{
std::cout<<"Error in doc example: no value for the example found !!!"<<std::endl;
isOK = false;
}
}
}
ApplicationRegistry::CleanRegistry();
if( !isOK )
return EXIT_FAILURE;
return EXIT_SUCCESS;
}
|
