summaryrefslogtreecommitdiffstats
path: root/src/object/sp-marker-loc.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/object/sp-marker-loc.h')
-rw-r--r--src/object/sp-marker-loc.h40
1 files changed, 40 insertions, 0 deletions
diff --git a/src/object/sp-marker-loc.h b/src/object/sp-marker-loc.h
new file mode 100644
index 0000000..6b88d69
--- /dev/null
+++ b/src/object/sp-marker-loc.h
@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/** @file
+ * TODO: insert short description here
+ *//*
+ * Authors: see git history
+ *
+ * Copyright (C) 2018 Authors
+ * Released under GNU GPL v2+, read the file 'COPYING' for more information.
+ */
+#ifndef SEEN_SP_MARKER_LOC_H
+#define SEEN_SP_MARKER_LOC_H
+
+/**
+ * These enums are to allow us to have 4-element arrays that represent a set of marker locations
+ * (all, start, mid, and end). This allows us to iterate through the array in places where we need
+ * to do a process across all of the markers, instead of separate code stanzas for each.
+ *
+ * IMPORTANT: the code assumes that the locations have the values as written below! so don't change the values!!!
+ */
+enum SPMarkerLoc {
+ SP_MARKER_LOC = 0,
+ SP_MARKER_LOC_START = 1,
+ SP_MARKER_LOC_MID = 2,
+ SP_MARKER_LOC_END = 3,
+ SP_MARKER_LOC_QTY = 4
+};
+
+
+#endif /* !SEEN_SP_MARKER_LOC_H */
+
+/*
+ Local Variables:
+ mode:c++
+ c-file-style:"stroustrup"
+ c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
+ indent-tabs-mode:nil
+ fill-column:99
+ End:
+*/
+// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :