<p>fixeria has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/libosmocore/+/20847">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">vty/command: introduce vty_dump_xml_ref_mode()<br><br>This change introduces an enumerated type 'vty_ref_gen_mode' that<br>(as the name suggests) defines the VTY reference generation mode:<br><br> - DEFAULT - all commands except deprecated and hidden,<br> - EXPERT - all commands including hidden, excluding deprecated;<br><br>and a new function vty_dump_xml_ref_mode(), that allows to specify<br>that mode. The old vty_dump_xml_ref() is now deprecated.<br><br>Change-Id: Ie2022a7f9e167e5ceacf15350c037dd43768ff40<br>Related: SYS#4910<br>---<br>M include/osmocom/vty/command.h<br>M src/vty/command.c<br>2 files changed, 53 insertions(+), 2 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/47/20847/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/vty/command.h b/include/osmocom/vty/command.h</span><br><span>index 92701fc..eb7ee35 100644</span><br><span>--- a/include/osmocom/vty/command.h</span><br><span>+++ b/include/osmocom/vty/command.h</span><br><span>@@ -29,6 +29,7 @@</span><br><span> #include "vector.h"</span><br><span> </span><br><span> #include <osmocom/core/defs.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/core/utils.h></span><br><span> </span><br><span> /*! \defgroup command VTY Command</span><br><span> * @{</span><br><span>@@ -460,6 +461,18 @@</span><br><span> </span><br><span> extern void *tall_vty_cmd_ctx;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-int vty_dump_xml_ref(FILE *stream);</span><br><span style="color: hsl(120, 100%, 40%);">+/*! VTY reference generation mode. */</span><br><span style="color: hsl(120, 100%, 40%);">+enum vty_ref_gen_mode {</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Default mode: all commands except deprecated and hidden. */</span><br><span style="color: hsl(120, 100%, 40%);">+ VTY_REF_GEN_MODE_DEFAULT = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Expert mode: all commands including hidden, excluding deprecated. */</span><br><span style="color: hsl(120, 100%, 40%);">+ VTY_REF_GEN_MODE_EXPERT,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+extern const struct value_string vty_ref_gen_mode_names[];</span><br><span style="color: hsl(120, 100%, 40%);">+extern const struct value_string vty_ref_gen_mode_desc[];</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+int vty_dump_xml_ref_mode(FILE *stream, enum vty_ref_gen_mode mode);</span><br><span style="color: hsl(120, 100%, 40%);">+int vty_dump_xml_ref(FILE *stream) OSMO_DEPRECATED("Use vty_dump_xml_ref_mode() instead");</span><br><span> </span><br><span> /*! @} */</span><br><span>diff --git a/src/vty/command.c b/src/vty/command.c</span><br><span>index 53ebcd8..b83522f 100644</span><br><span>--- a/src/vty/command.c</span><br><span>+++ b/src/vty/command.c</span><br><span>@@ -876,11 +876,49 @@</span><br><span> return rc;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+const struct value_string vty_ref_gen_mode_names[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+ { VTY_REF_GEN_MODE_DEFAULT, "default" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { VTY_REF_GEN_MODE_EXPERT, "expert" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { 0, NULL }</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+const struct value_string vty_ref_gen_mode_desc[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+ { VTY_REF_GEN_MODE_DEFAULT, "all commands except deprecated and hidden" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { VTY_REF_GEN_MODE_EXPERT, "all commands including hidden, excluding deprecated" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { 0, NULL }</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! Print the XML reference of all VTY nodes to the given stream.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[out] stream Output stream to print the XML reference to.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] mode The XML reference generation mode.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns always 0 for now, no errors possible.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int vty_dump_xml_ref_mode(FILE *stream, enum vty_ref_gen_mode mode)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (mode) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case VTY_REF_GEN_MODE_EXPERT:</span><br><span style="color: hsl(120, 100%, 40%);">+ host.expert_mode = true;</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case VTY_REF_GEN_MODE_DEFAULT:</span><br><span style="color: hsl(120, 100%, 40%);">+ default:</span><br><span style="color: hsl(120, 100%, 40%);">+ host.expert_mode = false;</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return vty_dump_nodes(print_func_stream, stream, "\n");</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*! Print the XML reference of all VTY nodes to the given stream.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[out] stream Output stream to print the XML reference to.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns always 0 for now, no errors possible.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * NOTE: this function is deprecated because it does not allow to</span><br><span style="color: hsl(120, 100%, 40%);">+ * specify the XML reference generation mode (default mode</span><br><span style="color: hsl(120, 100%, 40%);">+ * is hard-coded). Use vty_dump_xml_ref_mode() instead.</span><br><span> */</span><br><span> int vty_dump_xml_ref(FILE *stream)</span><br><span> {</span><br><span style="color: hsl(0, 100%, 40%);">- return vty_dump_nodes(print_func_stream, stream, "\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ return vty_dump_xml_ref_mode(stream, VTY_REF_GEN_MODE_DEFAULT);</span><br><span> }</span><br><span> </span><br><span> /* Check if a command with given string exists at given node */</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/libosmocore/+/20847">change 20847</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/libosmocore/+/20847"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: libosmocore </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Ie2022a7f9e167e5ceacf15350c037dd43768ff40 </div>
<div style="display:none"> Gerrit-Change-Number: 20847 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: fixeria <vyanitskiy@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>