This file is indexed.

/usr/include/torch/CmdLine.h is in libtorch3-dev 3.1-2.1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
// Copyright (C) 2003--2004 Ronan Collobert (collober@idiap.ch)
//                
// This file is part of Torch 3.1.
//
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. The name of the author may not be used to endorse or promote products
//    derived from this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef CMD_LINE_INC
#define CMD_LINE_INC

#include "Object.h"
#include "CmdOption.h"
#include "DiskXFile.h"

namespace Torch {

/** This class provides a useful interface for the user,
    to easily read some arguments/options from the command-line.
    
    Note that here, we make a difference between:
    \begin{itemize}
      \item {\bf options} which are not required.
      \item {\bf arguments} which are required.
    \end{itemize}

    Options:
    \begin{tabular}{lcll}
      "write log"  &  bool  &  Should I output the cmd.log file ? & [true]
    \end{tabular}

    @author Ronan Collobert (collober@idiap.ch)
    @see CmdOption
*/
class CmdLine : public Object
{
  public:
    char *program_name;
    bool write_log;
    int n_master_switches;
    int *n_cmd_options;
    CmdOption ***cmd_options;
    char *text_info;

    char *working_directory;
    char **associated_files;
    int n_associated_files;
    int master_switch;

    char **argv;
    int argc;

    // -----

    ///
    CmdLine();

    /** Read the command-line.
        Call this function {\bf after} adding options/arguments
        that you need, with the help of the following functions.
    */
    int read(int argc_, char **argv_);

    /** Print the help.
        Call this function {\bf after} adding options/arguments
        that you need, with the help of the following functions.
    */
    void help();

    //-----

    /** Functions for adding options.
        The calling order of the following functions will
        define the text order associated when you will call #help()#.
        
        Add an option (Int, Bool, Real, String).
        \begin{itemize}
          \item #name# the name of the option (must be unique).
          \item #ptr# is the pointer on the optional variable.
          \item #init_value# is the initialization value.
          \item #help# is the help text for this option.
        \end{itemize}
        
        The option will be setted to #value# in the command-line
        by printing "#name# #value#"
    */
    ///
    void addICmdOption(const char *name, int *ptr, int init_value, const char *help="", bool save_it=false);
    ///
    void addBCmdOption(const char *name, bool *ptr, bool init_value, const char *help="", bool save_it=false);
    ///
    void addRCmdOption(const char *name, real *ptr, real init_value, const char *help="", bool save_it=false);
    ///
    void addSCmdOption(const char *name, char **ptr, const char *init_value, const char *help="", bool save_it=false);

    /** Functions for adding an argument.
        The argument will be setted to #value# in the command-line
        by writting "#value#" {\bf after} all the options.
        If there are N arguments, you have to write
        "#value1# #value2# #value3# ... #valueN#" to set them in the
        command-line.
    */
    ///
    void addICmdArg(const char *name, int *ptr, const char *help="", bool save_it=false);
    ///
    void addBCmdArg(const char *name, bool *ptr, const char *help="", bool save_it=false);
    ///
    void addRCmdArg(const char *name, real *ptr, const char *help="", bool save_it=false);
    ///
    void addSCmdArg(const char *name, char **ptr, const char *help="", bool save_it=false);

    /// Add a text line in the help message.
    void addText(const char *text);

    /// Add a text at the beginnig of the help.
    void info(const char *text);

    /** Add a master switch.
        It creates an another type of command line.
        If the #text# is the first argument of the user command line,
        only the options corresponding to this new command line will be considered.
    */
    void addMasterSwitch(const char *text);

    /** Set the working directory.
        Use it with #getPath()# and #getXFile()#.
    */
    void setWorkingDirectory(const char* dirname);

    /** Get a full path.
        It adds the #working_directory# before the #filename#.
        This path will be deleted by CmdLine. */
    char *getPath(const char *filename);

    /** Get a DiskXFile.
        It adds the #working_directory# before the #filename# and opens the file.
        This XFile will be deleted by CmdLine. */
    DiskXFile *getXFile(const char *filename);
    
    /// Load the object from a file pointer (\emph{not the options})
    virtual void loadXFile(XFile *file);

    /// Save the object to a file pointer (\emph{not the options})
    virtual void saveXFile(XFile *file);

    //-----

    /** Add an option to the command line. Use this method
        if the wrappers that are provided are not sufficient.
    */
    void addCmdOption(CmdOption *option);

    /** Write a log in #file#.
        If desired, the associated files can be printed.
    */
    void writeLog(XFile *file, bool write_associated_files);

    virtual ~CmdLine();
};

}

#endif