summaryrefslogtreecommitdiff
path: root/source/core/slang-name-value.h
blob: a50e149a894a009dcb4f5e5446a1f4ae14fa6f74 (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
#ifndef SLANG_CORE_NAME_VALUE_H
#define SLANG_CORE_NAME_VALUE_H

#include "slang-basic.h"

#include "slang-array-view.h"

namespace Slang
{

// When associating values with names we use this type
typedef int32_t ValueInt;

struct NameValue
{
    ValueInt value;
    const char* name;
};

struct NamesValue
{
    ValueInt value;
    const char* names;          ///< Can hold comma delimited list of names
    
};

struct NamesDescriptionValue
{
    ValueInt value;
    const char* names;          ///< Can hold comma delimited list of names 
    const char* description;    ///< Optional description, can hold null ptr or empty string if not defined
};

struct NameValueUtil
{
    enum class NameKind
    {
        First,              ///< Only the first name if there is more than one
        All,                ///< All valid associated names
    };

        /// Use the default type to infer the actual type desired
    template <typename T>
    static T findValue(const ConstArrayView<NameValue>& opts, const UnownedStringSlice& slice, T defaultValue) { return (T)findValue(opts, slice, ValueInt(defaultValue)); }
    template <typename T>
    static T findValue(const ConstArrayView<NamesValue>& opts, const UnownedStringSlice& slice, T defaultValue) { return (T)findValue(opts, slice, ValueInt(defaultValue)); }
    template <typename T>
    static T findValue(const ConstArrayView<NamesDescriptionValue>& opts, const UnownedStringSlice& slice, T defaultValue) { return (T)findValue(opts, slice, ValueInt(defaultValue)); }

        /// Given a slice finds the associated value. If no entry is found, defaultValue is returned
    static ValueInt findValue(const ConstArrayView<NameValue>& opts, const UnownedStringSlice& slice, ValueInt defaultValue = -1);
    static ValueInt findValue(const ConstArrayView<NamesValue>& opts, const UnownedStringSlice& slice, ValueInt defaultValue = -1);
    static ValueInt findValue(const ConstArrayView<NamesDescriptionValue>& opts, const UnownedStringSlice& slice, ValueInt defaultValue = -1);

        /// Given a value find the name. If there are multiple names, returns the first name
    static UnownedStringSlice findName(const ConstArrayView<NameValue>& opts, ValueInt value, const UnownedStringSlice& defaultName = UnownedStringSlice());
    static UnownedStringSlice findName(const ConstArrayView<NamesValue>& opts, ValueInt value, const UnownedStringSlice& defaultName = UnownedStringSlice());
    static UnownedStringSlice findName(const ConstArrayView<NamesDescriptionValue>& opts, ValueInt value, const UnownedStringSlice& defaultName = UnownedStringSlice());

        /// Append all the names from opts to out
    static void appendNames(NameKind kind, const ConstArrayView<NameValue>& opts, List<UnownedStringSlice>& out);
    static void appendNames(NameKind kind, const ConstArrayView<NamesValue>& opts, List<UnownedStringSlice>& out);
    static void appendNames(NameKind kind, const ConstArrayView<NamesDescriptionValue>& opts, List<UnownedStringSlice>& out);

        /// Return the list of all valid names
    static List<UnownedStringSlice> getNames(NameKind kind, const ConstArrayView<NameValue>& opts);
    static List<UnownedStringSlice> getNames(NameKind kind, const ConstArrayView<NamesValue>& opts);
    static List<UnownedStringSlice> getNames(NameKind kind, const ConstArrayView<NamesDescriptionValue>& opts);
    
        /// Get the description
    static UnownedStringSlice findDescription(const ConstArrayView<NamesDescriptionValue>& opts, ValueInt value, const UnownedStringSlice& defaultDescription = UnownedStringSlice());
};

} // namespace Slang

#endif