summaryrefslogtreecommitdiffstats
path: root/src/object/sp-marker-loc.h
blob: 6b88d699912eb775ada4e04e15cafb732af20bb1 (plain)
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
// 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 :