Library of Assembled Shared Sources
util_common.h
Go to the documentation of this file.
1/** @file
2 * @author Bram de Greve (bram@cocamware.com)
3 * @author Tom De Muer (tom@cocamware.com)
4 *
5 * *** BEGIN LICENSE INFORMATION ***
6 *
7 * The contents of this file are subject to the Common Public Attribution License
8 * Version 1.0 (the "License"); you may not use this file except in compliance with
9 * the License. You may obtain a copy of the License at
10 * http://lass.sourceforge.net/cpal-license. The License is based on the
11 * Mozilla Public License Version 1.1 but Sections 14 and 15 have been added to cover
12 * use of software over a computer network and provide for limited attribution for
13 * the Original Developer. In addition, Exhibit A has been modified to be consistent
14 * with Exhibit B.
15 *
16 * Software distributed under the License is distributed on an "AS IS" basis, WITHOUT
17 * WARRANTY OF ANY KIND, either express or implied. See the License for the specific
18 * language governing rights and limitations under the License.
19 *
20 * The Original Code is LASS - Library of Assembled Shared Sources.
21 *
22 * The Initial Developer of the Original Code is Bram de Greve and Tom De Muer.
23 * The Original Developer is the Initial Developer.
24 *
25 * All portions of the code written by the Initial Developer are:
26 * Copyright (C) 2004-2011 the Initial Developer.
27 * All Rights Reserved.
28 *
29 * Contributor(s):
30 *
31 * Alternatively, the contents of this file may be used under the terms of the
32 * GNU General Public License Version 2 or later (the GPL), in which case the
33 * provisions of GPL are applicable instead of those above. If you wish to allow use
34 * of your version of this file only under the terms of the GPL and not to allow
35 * others to use your version of this file under the CPAL, indicate your decision by
36 * deleting the provisions above and replace them with the notice and other
37 * provisions required by the GPL License. If you do not delete the provisions above,
38 * a recipient may use your version of this file under either the CPAL or the GPL.
39 *
40 * *** END LICENSE INFORMATION ***
41 */
42
43/** @namespace lass::util
44 * @brief general utility, debug facilities, ...
45 *
46 * The util namespace contains general utilities, debug facilities, etc. used by our lass
47 * software. The following stuff is provided:
48 *
49 * - Allocator: library of custom allocator building blocks
50 * - Atomic: atomic operations on integers
51 * - Bind: bind function and arguments to nullary callback
52 * - @ref BitManip: a set of bit manipulation routines
53 * - @ref Callback: library to wrap callback functions in first class objects.
54 * - CallTraits: defines @e best types for arguments, references, etc.
55 * - Clock: an class to measure time.
56 * - CloneFactory: implements Alexandrescu's clone factory pattern.
57 * - @ref CommonMacros: a set of common macros for your convenience
58 * - Dictionary: a bidirectional dictonary wrapper around a std::map.
59 * - empty.h: an empty header for those moments you want to include absolutely @e nothing.
60 * - @ref Enforcers: release-time counterpart of assertions to ease condition verifying
61 * - Environment: accessing environment variables
62 * - Exception: the exception class used by LASS
63 * - IdGenerator: Generates unique ID's of the type you want (well, not @e all types).
64 * - NonCopyable: boost::non_copyable
65 * - ObjectFactory: implements Alexandrescu's object factory.
66 * - @ref Process: concerning process settings.
67 * - ProgressIndicator: a class to print a progress message.
68 * - @ref Python: Python binding library
69 * - Singleton: implements the singleton idiom in a non-intrusive way, very easy.
70 * - SmallObject: base class for small objects that need a specialized allocator.
71 * - @ref SmartPtr: library of configurable smart pointers like ScopedPtr and SharedPtr
72 * - @ref stringCast: casts a value to a type by using string streams, to cast to/from strings.
73 * - @ref Threading: basic multithreading library
74 * - @ref ThreadFun: Uses the Bind library to run existing functions in threads
75 * - ThreadPool: producer/consumer pattern with multithreading ...
76 * - @ref VisitorPattern: implements Alexandrescu's visitor pattern.
77 */
78
79
80
81/** @namespace lass::util::impl
82 * @internal
83 */
84
85#ifndef LASS_GUARDIAN_OF_INCLUSION_UTIL_UTIL_COMMON_H
86#define LASS_GUARDIAN_OF_INCLUSION_UTIL_UTIL_COMMON_H
87
88#include "../lass_common.h"
89
90#endif
lass_common.h