summaryrefslogtreecommitdiff
path: root/initfini/impl/simpleops-initfini-impl-doc.h
diff options
context:
space:
mode:
Diffstat (limited to 'initfini/impl/simpleops-initfini-impl-doc.h')
-rw-r--r--initfini/impl/simpleops-initfini-impl-doc.h58
1 files changed, 58 insertions, 0 deletions
diff --git a/initfini/impl/simpleops-initfini-impl-doc.h b/initfini/impl/simpleops-initfini-impl-doc.h
new file mode 100644
index 0000000..7833ec0
--- /dev/null
+++ b/initfini/impl/simpleops-initfini-impl-doc.h
@@ -0,0 +1,58 @@
+/* -*- Mode: c; c-basic-offset: 4; indent-tabs-mode: t; tab-width: 8; -*- */
+/*
+ * Copyright 2010-2011 Andrea Canciani
+ *
+ * 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.
+ *
+ * Author(s): Andrea Canciani <ranma42@gmail.com>
+ */
+
+#ifndef SIMPLEOPS_INITFINI_IMPL_DOC_H
+#define SIMPLEOPS_INITFINI_IMPL_DOC_H
+
+#ifndef SIMPLEOPS_INITFINI_IMPL_H
+#error Private header used directly
+#endif
+
+#if ! SIMPLEOPS_HAVE_INITFINI_IMPL && \
+ SIMPLEOPS_DOC
+
+/**
+ * Defined whenever the simpleops library is providing an
+ * implementation of initialization and termination operations.
+ *
+ * Initialization is performed exaclty once, as soon as the
+ * application or library is loaded, before any other code is
+ * executed. In a similar way, finalization is performed exactly once,
+ * when the application or library is being unloaded.
+ */
+#define SIMPLEOPS_HAVE_INITFINI_IMPL 1
+
+/**
+ * SIMPLEOPS_HAVE_INITFINI_IMPL_* identifies which implementation is
+ * being used in the simpleops library to provide
+ * initialization/termination operations.
+ */
+#define SIMPLEOPS_HAVE_INITFINI_IMPL_DOC 1
+
+#endif
+
+#endif