xref: /gem5/util/tlm/examples/common/cli_parser.hh

/*
 * Copyright (c) 2016, Dresden University of Technology (TU Dresden)
 * 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. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 COPYRIGHT HOLDER
 * OR CONTRIBUTORS 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.
 *
 * Authors: Christian Menard
 */

#ifndef __CLI_PARSER_HH__
#define __CLI_PARSER_HH__

#include <cassert>
#include <string>
#include <vector>

class CliParser
{
  private:
    int argc;
    char** argv;

    bool parsed;

    uint64_t memoryOffset;
    uint64_t simulationEnd;
    bool verboseFlag;
    std::vector<std::string> debugFlags;
    std::string configFile;

    void usage(const std::string& prog_name);
  public:

    CliParser() : parsed(false) {}

    void parse(int argc, char** argv);

    uint64_t getMemoryOffset()  { assert(parsed); return memoryOffset; }
    uint64_t getSimulationEnd() { assert(parsed); return simulationEnd; }
    bool getVerboseFlag()       { assert(parsed); return verboseFlag; }
    std::string getConfigFile() { assert(parsed); return configFile; }
    std::string getDebugFlags();
};

#endif