<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.15.0" xml:lang="en-US">
  <compounddef id="group__message__utils" kind="group">
    <compoundname>message_utils</compoundname>
    <title>Messages</title>
    <sectiondef kind="func">
      <memberdef kind="function" id="group__message__utils_1ga36b35be01d7f36cf7f59c245eee628d1" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void vrna_message_error</definition>
        <argsstring>(const char *format,...)</argsstring>
        <name>vrna_message_error</name>
        <param>
          <type>const char *</type>
          <declname>format</declname>
        </param>
        <param>
          <type>...</type>
        </param>
        <briefdescription>
<para>Print an error message and die. </para>
        </briefdescription>
        <detaileddescription>
<para>This function is a wrapper to <emphasis>fprintf(stderr, ...)</emphasis> that puts a capital <bold>ERROR:</bold> in front of the message and then exits the calling program.</para>
<para><simplesect kind="see"><para><ref refid="group__message__utils_1gabc1a08dea0d84b5c33701732172a8b18" kindref="member">vrna_message_verror()</ref>, <ref refid="group__message__utils_1ga6e07ed24add60693ba886d54d0a46635" kindref="member">vrna_message_warning()</ref>, <ref refid="group__message__utils_1ga039bae6153a6415b054dbe6045f83d03" kindref="member">vrna_message_info()</ref></para>
</simplesect>
<xrefsect id="deprecated_1_deprecated000232"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Use <ref refid="group__utils__log_1ga8da5560f12f62e4afc523e3ee26e8017" kindref="member">vrna_log_error()</ref> instead! (since v2.7.0)</para>
</xrefdescription></xrefsect></para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>format</parametername>
</parameternamelist>
<parameterdescription>
<para>The error message to be printed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>...</parametername>
</parameternamelist>
<parameterdescription>
<para>Optional arguments for the formatted message string </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="ViennaRNA/utils/basic.h" line="328" column="18" declfile="ViennaRNA/utils/basic.h" declline="328" declcolumn="18"/>
      </memberdef>
      <memberdef kind="function" id="group__message__utils_1gabc1a08dea0d84b5c33701732172a8b18" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void vrna_message_verror</definition>
        <argsstring>(const char *format, va_list args)</argsstring>
        <name>vrna_message_verror</name>
        <param>
          <type>const char *</type>
          <declname>format</declname>
        </param>
        <param>
          <type>va_list</type>
          <declname>args</declname>
        </param>
        <briefdescription>
<para>Print an error message and die. </para>
        </briefdescription>
        <detaileddescription>
<para>This function is a wrapper to <emphasis>vfprintf(stderr, ...)</emphasis> that puts a capital <bold>ERROR:</bold> in front of the message and then exits the calling program.</para>
<para><simplesect kind="see"><para><ref refid="group__message__utils_1ga36b35be01d7f36cf7f59c245eee628d1" kindref="member">vrna_message_error()</ref>, <ref refid="group__message__utils_1ga6e07ed24add60693ba886d54d0a46635" kindref="member">vrna_message_warning()</ref>, <ref refid="group__message__utils_1ga039bae6153a6415b054dbe6045f83d03" kindref="member">vrna_message_info()</ref></para>
</simplesect>
<xrefsect id="deprecated_1_deprecated000233"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Use <ref refid="group__utils__log_1ga8da5560f12f62e4afc523e3ee26e8017" kindref="member">vrna_log_error()</ref> instead! (since v2.7.0)</para>
</xrefdescription></xrefsect></para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>format</parametername>
</parameternamelist>
<parameterdescription>
<para>The error message to be printed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>args</parametername>
</parameternamelist>
<parameterdescription>
<para>The argument list for the formatted message string </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="ViennaRNA/utils/basic.h" line="348" column="18" declfile="ViennaRNA/utils/basic.h" declline="348" declcolumn="18"/>
      </memberdef>
      <memberdef kind="function" id="group__message__utils_1ga6e07ed24add60693ba886d54d0a46635" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void vrna_message_warning</definition>
        <argsstring>(const char *format,...)</argsstring>
        <name>vrna_message_warning</name>
        <param>
          <type>const char *</type>
          <declname>format</declname>
        </param>
        <param>
          <type>...</type>
        </param>
        <briefdescription>
<para>Print a warning message. </para>
        </briefdescription>
        <detaileddescription>
<para>This function is a wrapper to <emphasis>fprintf(stderr, ...)</emphasis> that puts a capital <bold>WARNING:</bold> in front of the message.</para>
<para><simplesect kind="see"><para><ref refid="group__message__utils_1ga377aa8ec8a49d343063adb22e6311f26" kindref="member">vrna_message_vwarning()</ref>, <ref refid="group__message__utils_1ga36b35be01d7f36cf7f59c245eee628d1" kindref="member">vrna_message_error()</ref>, <ref refid="group__message__utils_1ga039bae6153a6415b054dbe6045f83d03" kindref="member">vrna_message_info()</ref></para>
</simplesect>
<xrefsect id="deprecated_1_deprecated000234"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Use <ref refid="group__utils__log_1ga0cd0cd19f100942b3a0e3911b9aa94b9" kindref="member">vrna_log_warning()</ref> instead! (since v2.7.0)</para>
</xrefdescription></xrefsect></para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>format</parametername>
</parameternamelist>
<parameterdescription>
<para>The warning message to be printed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>...</parametername>
</parameternamelist>
<parameterdescription>
<para>Optional arguments for the formatted message string </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="ViennaRNA/utils/basic.h" line="367" column="18" declfile="ViennaRNA/utils/basic.h" declline="367" declcolumn="18"/>
      </memberdef>
      <memberdef kind="function" id="group__message__utils_1ga377aa8ec8a49d343063adb22e6311f26" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void vrna_message_vwarning</definition>
        <argsstring>(const char *format, va_list args)</argsstring>
        <name>vrna_message_vwarning</name>
        <param>
          <type>const char *</type>
          <declname>format</declname>
        </param>
        <param>
          <type>va_list</type>
          <declname>args</declname>
        </param>
        <briefdescription>
<para>Print a warning message. </para>
        </briefdescription>
        <detaileddescription>
<para>This function is a wrapper to <emphasis>fprintf(stderr, ...)</emphasis> that puts a capital <bold>WARNING:</bold> in front of the message.</para>
<para><simplesect kind="see"><para><ref refid="group__message__utils_1ga377aa8ec8a49d343063adb22e6311f26" kindref="member">vrna_message_vwarning()</ref>, <ref refid="group__message__utils_1ga36b35be01d7f36cf7f59c245eee628d1" kindref="member">vrna_message_error()</ref>, <ref refid="group__message__utils_1ga039bae6153a6415b054dbe6045f83d03" kindref="member">vrna_message_info()</ref></para>
</simplesect>
<xrefsect id="deprecated_1_deprecated000235"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Use <ref refid="group__utils__log_1ga0cd0cd19f100942b3a0e3911b9aa94b9" kindref="member">vrna_log_warning()</ref> instead! (since v2.7.0)</para>
</xrefdescription></xrefsect></para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>format</parametername>
</parameternamelist>
<parameterdescription>
<para>The warning message to be printed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>args</parametername>
</parameternamelist>
<parameterdescription>
<para>The argument list for the formatted message string </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="ViennaRNA/utils/basic.h" line="386" column="18" declfile="ViennaRNA/utils/basic.h" declline="386" declcolumn="18"/>
      </memberdef>
      <memberdef kind="function" id="group__message__utils_1ga039bae6153a6415b054dbe6045f83d03" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void vrna_message_info</definition>
        <argsstring>(FILE *fp, const char *format,...)</argsstring>
        <name>vrna_message_info</name>
        <param>
          <type>FILE *</type>
          <declname>fp</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>format</declname>
        </param>
        <param>
          <type>...</type>
        </param>
        <briefdescription>
<para>Print an info message. </para>
        </briefdescription>
        <detaileddescription>
<para>This function is a wrapper to <emphasis>fprintf(...)</emphasis>.</para>
<para><simplesect kind="see"><para><ref refid="group__message__utils_1gad8b8139bd04fbfb51e398e9fcd6908dc" kindref="member">vrna_message_vinfo()</ref>, <ref refid="group__message__utils_1ga36b35be01d7f36cf7f59c245eee628d1" kindref="member">vrna_message_error()</ref>, <ref refid="group__message__utils_1ga6e07ed24add60693ba886d54d0a46635" kindref="member">vrna_message_warning()</ref></para>
</simplesect>
<xrefsect id="deprecated_1_deprecated000236"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Use <ref refid="group__utils__log_1ga74ffae709f4db9d02cbd07b1e09b8f50" kindref="member">vrna_log_info()</ref> instead! (since v2.7.0)</para>
</xrefdescription></xrefsect></para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>fp</parametername>
</parameternamelist>
<parameterdescription>
<para>The file pointer where the message is printed to </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>format</parametername>
</parameternamelist>
<parameterdescription>
<para>The warning message to be printed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>...</parametername>
</parameternamelist>
<parameterdescription>
<para>Optional arguments for the formatted message string </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="ViennaRNA/utils/basic.h" line="406" column="18" declfile="ViennaRNA/utils/basic.h" declline="406" declcolumn="18"/>
      </memberdef>
      <memberdef kind="function" id="group__message__utils_1gad8b8139bd04fbfb51e398e9fcd6908dc" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void vrna_message_vinfo</definition>
        <argsstring>(FILE *fp, const char *format, va_list args)</argsstring>
        <name>vrna_message_vinfo</name>
        <param>
          <type>FILE *</type>
          <declname>fp</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>format</declname>
        </param>
        <param>
          <type>va_list</type>
          <declname>args</declname>
        </param>
        <briefdescription>
<para>Print an info message. </para>
        </briefdescription>
        <detaileddescription>
<para>This function is a wrapper to <emphasis>fprintf(...)</emphasis>.</para>
<para><simplesect kind="see"><para><ref refid="group__message__utils_1gad8b8139bd04fbfb51e398e9fcd6908dc" kindref="member">vrna_message_vinfo()</ref>, <ref refid="group__message__utils_1ga36b35be01d7f36cf7f59c245eee628d1" kindref="member">vrna_message_error()</ref>, <ref refid="group__message__utils_1ga6e07ed24add60693ba886d54d0a46635" kindref="member">vrna_message_warning()</ref></para>
</simplesect>
<xrefsect id="deprecated_1_deprecated000237"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Use <ref refid="group__utils__log_1ga74ffae709f4db9d02cbd07b1e09b8f50" kindref="member">vrna_log_info()</ref> instead! (since v2.7.0)</para>
</xrefdescription></xrefsect></para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>fp</parametername>
</parameternamelist>
<parameterdescription>
<para>The file pointer where the message is printed to </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>format</parametername>
</parameternamelist>
<parameterdescription>
<para>The info message to be printed </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>args</parametername>
</parameternamelist>
<parameterdescription>
<para>The argument list for the formatted message string </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="ViennaRNA/utils/basic.h" line="426" column="18" declfile="ViennaRNA/utils/basic.h" declline="426" declcolumn="18"/>
      </memberdef>
      <memberdef kind="function" id="group__message__utils_1gaee1dd652ca5b9e56b096963a1576f73b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void vrna_message_input_seq_simple</definition>
        <argsstring>(void)</argsstring>
        <name>vrna_message_input_seq_simple</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Print a line to <emphasis>stdout</emphasis> that asks for an input sequence. </para>
        </briefdescription>
        <detaileddescription>
<para>There will also be a ruler (scale line) printed that helps orientation of the sequence positions </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="ViennaRNA/utils/basic.h" line="435" column="1" declfile="ViennaRNA/utils/basic.h" declline="435" declcolumn="1"/>
      </memberdef>
      <memberdef kind="function" id="group__message__utils_1gaf4d194d558b0c975f269de01dea52460" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void vrna_message_input_seq</definition>
        <argsstring>(const char *s)</argsstring>
        <name>vrna_message_input_seq</name>
        <param>
          <type>const char *</type>
          <declname>s</declname>
        </param>
        <briefdescription>
<para>Print a line with a user defined string and a ruler to stdout. </para>
        </briefdescription>
        <detaileddescription>
<para>(usually this is used to ask for user input) There will also be a ruler (scale line) printed that helps orientation of the sequence positions</para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>s</parametername>
</parameternamelist>
<parameterdescription>
<para>A user defined string that will be printed to stdout </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="ViennaRNA/utils/basic.h" line="447" column="1" declfile="ViennaRNA/utils/basic.h" declline="447" declcolumn="1"/>
      </memberdef>
      <memberdef kind="function" id="group__message__utils_1ga32445b4d868708899f8b928b2b7f1259" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void vrna_message_input_msa</definition>
        <argsstring>(const char *s)</argsstring>
        <name>vrna_message_input_msa</name>
        <param>
          <type>const char *</type>
          <declname>s</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="ViennaRNA/utils/basic.h" line="451" column="1" declfile="ViennaRNA/utils/basic.h" declline="451" declcolumn="1"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>
