Computer Assisted Medical Intervention Tool Kit  version 5.1
CamiTKAPI.h
Go to the documentation of this file.
1/*****************************************************************************
2 * $CAMITK_LICENCE_BEGIN$
3 *
4 * CamiTK - Computer Assisted Medical Intervention ToolKit
5 * (c) 2001-2023 Univ. Grenoble Alpes, CNRS, Grenoble INP, TIMC, 38000 Grenoble, France
6 *
7 * Visit http://camitk.imag.fr for more information
8 *
9 * This file is part of CamiTK.
10 *
11 * CamiTK is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * CamiTK is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License version 3 for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22 *
23 * $CAMITK_LICENCE_END$
24 ****************************************************************************/
25
26#ifndef CAMITK_API_H
27#define CAMITK_API_H
28
29// -----------------------------------------------------------------------
30//
31// CAMITK_API
32//
33// -----------------------------------------------------------------------
34// The following ifdef block is the standard way of creating macros which make exporting
35// from a DLL simpler. All files within this DLL are compiled with the COMPILE_CAMITK_API
36// flag defined on the command line. this symbol should not be defined on any project
37// that uses this DLL. This way any other project whose source files include this file see
38// CAMITK_API functions as being imported from a DLL, whereas this DLL sees symbols
39// defined with this macro as being exported.
40#if defined(_WIN32) // MSVC and mingw
41#ifdef COMPILE_CAMITK_API
42#define CAMITK_API __declspec(dllexport)
43#else
44#define CAMITK_API __declspec(dllimport)
45#endif
46#else
47// for all other platforms CAMITK_API is defined to be "nothing"
48#ifndef CAMITK_API
49#define CAMITK_API
50#endif
51#endif // MSVC and mingw
52
53// -----------------------------------------------------------------------
54// It seems that MSVC does not understand exception specification
55// If I understand it well, when _declspec() is used, there is a default
56// nothrow attribute.
57// I did not find the throw attribute. It seems that msvc is therefore ignoring the
58// specification of the type of the exception.
59// The compiler therefore issues a warning.
60// The following line is to avoid this particular warning.
61// The best would be to ask msvc not only to take the exception into account, but also
62// its type. Anyway, I did not find how to do that anywhere, and I am not sure this is
63// possible...
64#if defined(_WIN32) && !defined(__MINGW32__) // MSVC only
65#pragma warning( disable : 4290 )
66#endif // MSVC only
67
68// -----------------------------------------------------------------------
69// MSVC does not have the C++ Standard rint function (it should be included in any C99 implementation)
70#if defined(_WIN32) && !defined(__MINGW32__) &&(_MSC_VER < 1800)
71extern double rint(double x);
72#endif
73
74// -----------------------------------------------------------------------
75// -- QT stuff
76#include <QList>
77#include <QSet>
78#include <QMap>
79#include <QString>
80
81// -----------------------------------------------------------------------
82// warning when using deprecated methods
83//
84// prefix each deprecated method by the CAMITK_API_DEPRECATED keyword
85// CAMITK_API_DEPRECATED("Please use myNewMethod(..) instead") mymethod(...)
86//
87// see https://stackoverflow.com/a/295229
88#if defined(__GNUC__) || defined(__clang__)
89#define CAMITK_API_DEPRECATED(X) __attribute__((deprecated(X)))
90#elif defined(_MSC_VER)
91#define CAMITK_API_DEPRECATED(X) __declspec(deprecated(X))
92#else
93#pragma message("WARNING: You need to implement CAMITK_API_DEPRECATED(X) for this compiler")
94#define CAMITK_API_DEPRECATED(X)
95#endif
96
97// -----------------------------------------------------------------------
98// warning when using deprecated methods
99//
100// prefix each deprecated method by the CAMITK_API_DEPRECATED keyword
101// CAMITK_API_NOT_IMPLEMENTED mymethod(...)
102//
103// This is silent during CamiTK Core compilation
104#if !defined(COMPILE_CAMITK_API)
105#if defined(__GNUC__) || defined(__clang__)
106#define CAMITK_API_UNIMPLEMENTED __attribute__((deprecated("Unimplemeted method. Do not hesitate to contribute to CamiTK API!")))
107#elif defined(_MSC_VER)
108#define CAMITK_API_UNIMPLEMENTED __declspec(deprecated("Unimplemeted method. Do not hesitate to contribute to CamiTK API!"))
109#endif // elif
110#else
111// inside CamiTK Core compilation
112#define CAMITK_API_UNIMPLEMENTED
113#if !defined(__GNUC__) && !defined(__clang__) && !defined(_MSC_VER)
114#pragma message("WARNING: You need to implement CAMITK_API_UNIMPLEMENTED() for this compiler")
115#endif
116#endif // COMPILE_CAMITK_API
117
118// -----------------------------------------------------------------------
119// -- Definition of some useful CamiTK container types
120namespace camitk {
121// -- Core stuff Classes
122class Component;
123class Action;
124class Viewer;
125
127using ComponentList = QList<Component*>;
128
130using ActionSet = QSet<Action*>;
131
133using ViewerSet = QSet<Viewer*>;
134
136using ActionList = QList<Action*>;
137
139using ViewerList = QList<Viewer*>;
140}
141#endif
A component is something that composed something and could also be a part of something.
Definition: modeling/libraries/pml/Component.h:48
Definition: Action.cpp:35
QList< Viewer * > ViewerList
A list of Viewer.
Definition: CamiTKAPI.h:139
QSet< Action * > ActionSet
A set of Action.
Definition: CamiTKAPI.h:130
QList< Action * > ActionList
A list of Action.
Definition: CamiTKAPI.h:136
QList< Component * > ComponentList
A list of Component.
Definition: CamiTKAPI.h:127
QSet< Viewer * > ViewerSet
A set of Viewer.
Definition: CamiTKAPI.h:133