CommandLine.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_SRC_COMMANDLINE_H
#define SQUID_SRC_COMMANDLINE_H
 
#if HAVE_GETOPT_H
#include <getopt.h>
#endif
#include <vector>
 
typedef struct option RawLongOption;
 
class LongOption : public RawLongOption
{
public:
    LongOption();
    explicit LongOption(const RawLongOption &);
    LongOption(const LongOption&);
    LongOption &operator =(const LongOption &);
    ~LongOption();
 
private:
    void copy(const RawLongOption &);
};
 
class CommandLine
{
public:
    CommandLine(int argc, char *argv[], const char *shortRules, const RawLongOption *longRules);
    CommandLine(const CommandLine &them);
    ~CommandLine();
 
    CommandLine &operator =(const CommandLine &);
 
    bool hasOption(const int optId, const char **optValue = nullptr) const;
 
    typedef void Visitor(const int optId, const char *optValue);
 
    void forEachOption(Visitor) const;
 
    const char *arg0() const { return argv_[0]; }
 
    int argc() const { return static_cast<int>(argv_.size()) - 1; }
 
    char **argv() const { return const_cast<char**>(argv_.data()); }
 
    void resetArg0(const char *programName);
 
    void pushFrontOption(const char *name, const char *value = nullptr);
 
private:
    const RawLongOption *longOptions() const { return longOptions_.size() ? longOptions_.data() : nullptr; }
    bool nextOption(int &optId) const;
 
    std::vector<char *> argv_;
 
    /* getopt_long() grammar rules */
    const char *shortOptions_; 
    std::vector<LongOption> longOptions_; 
};
 
#endif /* SQUID_SRC_COMMANDLINE_H */