/usr/include/vigra/utilities.hxx is in libvigraimpex-dev 1.10.0+git20160211.167be93+dfsg-2+b5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | /************************************************************************/
/* */
/* Copyright 1998-2002 by Ullrich Koethe */
/* */
/* This file is part of the VIGRA computer vision library. */
/* The VIGRA Website is */
/* http://hci.iwr.uni-heidelberg.de/vigra/ */
/* Please direct questions, bug reports, and contributions to */
/* ullrich.koethe@iwr.uni-heidelberg.de or */
/* vigra@informatik.uni-hamburg.de */
/* */
/* Permission is hereby granted, free of charge, to any person */
/* obtaining a copy of this software and associated documentation */
/* files (the "Software"), to deal in the Software without */
/* restriction, including without limitation the rights to use, */
/* copy, modify, merge, publish, distribute, sublicense, and/or */
/* sell copies of the Software, and to permit persons to whom the */
/* Software is furnished to do so, subject to the following */
/* conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the */
/* Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES */
/* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND */
/* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT */
/* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, */
/* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING */
/* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR */
/* OTHER DEALINGS IN THE SOFTWARE. */
/* */
/************************************************************************/
#ifndef VIGRA_BASICS_HXX
#define VIGRA_BASICS_HXX
#include "config.hxx"
#include "error.hxx"
#include "metaprogramming.hxx"
#include "tuple.hxx"
#include "diff2d.hxx"
#include "mathutil.hxx"
#include <string>
#include <sstream>
#include <cctype>
/*! \file */
namespace vigra {
/** Convert a value to a string. Available for integral and floating point types
and void *.
*/
doxygen_overloaded_function(template <class T> std::string asString(T t))
#define VIGRA_AS_STRING(T) \
inline std::string asString(T t) \
{ \
std::stringstream s; \
s << t; \
return s.str(); \
}
VIGRA_AS_STRING(bool)
VIGRA_AS_STRING(signed char)
VIGRA_AS_STRING(unsigned char)
VIGRA_AS_STRING(signed short)
VIGRA_AS_STRING(unsigned short)
VIGRA_AS_STRING(signed long)
VIGRA_AS_STRING(unsigned long)
VIGRA_AS_STRING(signed long long)
VIGRA_AS_STRING(unsigned long long)
VIGRA_AS_STRING(signed int)
VIGRA_AS_STRING(unsigned int)
VIGRA_AS_STRING(float)
VIGRA_AS_STRING(double)
VIGRA_AS_STRING(long double)
VIGRA_AS_STRING(void *)
#undef VIGRA_AS_STRING
template <class T>
std::string operator<<(std::string const & s, T const & t)
{
std::stringstream ss;
ss << t;
return s + ss.str();
}
/** Convert string to lower case.
*/
inline std::string tolower(std::string s)
{
for(unsigned int k=0; k<s.size(); ++k)
s[k] = (std::string::value_type)std::tolower(s[k]);
return s;
}
inline std::string tolower(const char * s)
{
return tolower(std::string(s));
}
/** Convert string to lower case and remove any white space characters.
*/
inline std::string normalizeString(std::string const & s)
{
std::string res;
for(unsigned int k=0; k<s.size(); ++k)
{
if(std::isspace(s[k]))
continue;
res += (std::string::value_type)std::tolower(s[k]);
}
return res;
}
inline std::string normalizeString(const char * s)
{
return normalizeString(std::string(s));
}
namespace detail {
template <class T>
struct FinallyImpl
{
T & destructor_;
FinallyImpl(T & destructor)
: destructor_(destructor)
{}
~FinallyImpl()
{
destructor_();
}
};
} // namespace detail
} // namespace vigra
#define VIGRA_TOKEN_PASTE_IMPL(x, y) x##y
#define VIGRA_TOKEN_PASTE(x, y) VIGRA_TOKEN_PASTE_IMPL(x, y)
#define VIGRA_FINALLY_IMPL(destructor, counter) \
auto VIGRA_TOKEN_PASTE(_vigra_finally_impl_, counter) = [&]() { destructor; }; \
::vigra::detail::FinallyImpl<decltype(VIGRA_TOKEN_PASTE(_vigra_finally_impl_, counter))> \
VIGRA_TOKEN_PASTE(_vigra_finally_, counter)(VIGRA_TOKEN_PASTE(_vigra_finally_impl_, counter))
/** Emulate the 'finally' keyword as known from Python and other languages.
This macro improves upon the famous
<a href="http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization">Resource Acquisition Is Initialization</a> idiom, where a resource (e.g. heap memory or a mutex) is automatically free'ed when program execution leaves the current scope. Normally, this is implemented by calling a suitable function in the destructor of a dedicated helper class (e.g. <tt>std::unique_ptr</tt> or <tt>std::lock_guard<std::mutex></tt>).
Traditionally, a separate helper class has to be implemented for each kind of resource to be handled. In contrast, the macro <tt>VIGRA_FINALLY</tt> creates such a class on the fly by means of an embedded lambda expression.
<b>Usage:</b>
<b>\#include</b> \<vigra/utilities.hxx\><br/>
\code
std::mutex my_mutex;
...
{
// the following two lines are equivalent to
// std::unique_ptr<std::string> my_string = new std::string("foo");
std::string * my_string = new std::string("foo");
VIGRA_FINALLY(delete my_string);
// the following two lines are equivalent to
// std::lock_guard<std::mutex> lock(my_mutex);
my_mutex.lock();
VIGRA_FINALLY(my_mutex.unlock());
...
}
// the string has been deallocated and the mutex is unlocked
\endcode
You can pass any code to this macro. Multiple statements must be enclosed in braces as usual. Arbitrary many calls to <tt>VIGRA_FINALLY</tt> can be placed in the same scope. Their actions will be executed in the reversed order of declaration:
\code
int i = 0;
...
{
VIGRA_FINALLY({ // execute multiple statements
i = i*i;
++i;
});
VIGRA_FINALLY( i += 2 ); // this executes first
assert(i == 0); // as yet, nothing happend
}
assert(i == 5); // 'finally' code was executed in reversed order at end-of-scope
\endcode
This idea was popularized by Marko Tintor in "<a href="http://blog.memsql.com/c-error-handling-with-auto/">The Auto Macro: A Clean Approach to C++ Error Handling</a>".
*/
#define VIGRA_FINALLY(destructor) \
VIGRA_FINALLY_IMPL(destructor, __COUNTER__)
namespace std {
template <class T1, class T2>
ostream & operator<<(ostream & s, std::pair<T1, T2> const & p)
{
s << "(" << p.first << ", " << p.second << ")";
return s;
}
}
/** \page Utilities Utilities
Basic helper functionality needed throughout.
<UL style="list-style-image:url(documents/bullet.gif)">
<LI> \ref vigra::ArrayVector
<BR> <em>replacement for std::vector (always uses consecutive memory)</em>
<LI> \ref vigra::Any
<BR> <em>typesafe storage of arbitrary values</em>
<LI> \ref vigra::BucketQueue and \ref vigra::MappedBucketQueue
<BR> <em>efficient priority queues for integer priorities</em>
<LI> \ref RangesAndPoints
<BR> <em>2-D and N-D positions, extents, and boxes</em>
<LI> \ref PixelNeighborhood
<BR> <em>4- and 8-neighborhood definitions and circulators</em>
<LI> \ref VoxelNeighborhood
<BR> <em>6- and 26-neighborhood definitions and circulators</em>
<LI> \ref vigra::IteratorAdaptor
<BR> <em>Quickly create STL-compatible 1D iterator adaptors</em>
<LI> \ref TupleTypes
<BR> <em>pair, triple, tuple4, tuple5</em>
<LI> \ref MathConstants
<BR> <em>M_PI, M_SQRT2</em>
<LI> \ref TimingMacros
<BR> <em>Macros for taking execution speed measurements</em>
<LI> \ref VIGRA_FINALLY
<BR> <em>Emulation of the 'finally' keyword from Python</em>
</UL>
*/
#endif // VIGRA_BASICS_HXX
|