xref: /freebsd/lib/libifconfig/libifconfig_sfp_tables.tpl.c (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 /*-
2  * Copyright (c) 2020, Ryan Moeller <freqlabs@FreeBSD.org>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 {# THIS IS A TEMPLATE PROCESSED BY lib/libifconfig/sfp.lua #}
29 
30 #include <libifconfig_sfp_tables.h>
31 #include <libifconfig_sfp_tables_internal.h>
32 
33 struct sfp_enum_metadata {
34 	int		value;		/* numeric discriminant value */
35 	const char	*symbol;	/* symbolic name */
36 	const char	*description;	/* brief description */
37 	const char	*display;	/* shortened display name */
38 };
39 
40 const struct sfp_enum_metadata *
41 find_metadata(const struct sfp_enum_metadata *table, int value)
42 {
43 	while (table->value != value && table->symbol != NULL)
44 		++table;
45 	return (table->symbol != NULL ? table : NULL);
46 }
47 
48 {%
49 for _, ent in ipairs(enums) do
50     if type(ent) == "string" then
51 %}
52 /*
53  * {*ent*}
54  */
55 
56 {%
57     else
58         local enum = ent
59         local name = "sfp_"..enum.name
60         local sym, desc, disp
61 %}
62 static const struct sfp_enum_metadata {*name*}_table_[] = {
63 {%
64         for _, item in ipairs(enum.values) do
65             _, sym, desc, disp = table.unpack(item)
66             local symbol = string.upper(name).."_"..sym
67 %}
68 	{
69 		.value = {*symbol*},
70 		.symbol = "{*symbol*}",
71 		.description = "{*desc*}",
72 {%
73             if disp then
74 %}
75 		.display = "{*disp*}",
76 {%
77             end
78 %}
79 	},
80 {%
81         end
82 %}
83 	{0}
84 };
85 const struct sfp_enum_metadata *{*name*}_table = {*name*}_table_;
86 
87 const char *
88 ifconfig_{*name*}_symbol(enum {*name*} v)
89 {
90 	const struct sfp_enum_metadata *metadata;
91 
92 	if ((metadata = find_metadata({*name*}_table, v)) == NULL)
93 		return (NULL);
94 	return (metadata->symbol);
95 }
96 
97 const char *
98 ifconfig_{*name*}_description(enum {*name*} v)
99 {
100 	const struct sfp_enum_metadata *metadata;
101 
102 	if ((metadata = find_metadata({*name*}_table, v)) == NULL)
103 		return (NULL);
104 	return (metadata->description);
105 }
106 
107 {%
108         if disp then
109 %}
110 const char *
111 ifconfig_{*name*}_display(enum {*name*} v)
112 {
113 	const struct sfp_enum_metadata *metadata;
114 
115 	if ((metadata = find_metadata({*name*}_table, v)) == NULL)
116 		return (NULL);
117 	return (metadata->display);
118 }
119 
120 {%
121         end
122     end
123 end
124 %}
125