behnamasadi / gflag_glog_tutorials

This repository contains my snippets/ tutorials code for using Google Falgs (gflag) and Google Log (glog).

• Google Falgs and Google Log Tutorials
  • Command
  • Option
  • Installation
  • Google Falgs
    • Commandline Flag and Commandline Argument
    • Defining Flags In Program
    • Accessing the Flag
    • Sanity Checking Flag Values
    • Putting It Together
    • Special Flags
  • Google Log

Google Falgs and Google Log Tutorials

This repository contains my tutorial code for using Google Falgs and Google Log in my C++ projects.
In the context of command-line interfaces, such as those used in Git, UNIX, and other systems, the terms "command" and "option" have specific meanings and roles:

Command

A Commands are the core instructions to be executed. For example, in the command-line instruction git commit, git is the program being called, and commit is the command telling the program to record changes to the repository.

Commands can stand alone without options, although their behavior will be the default configuration set by the program.

Option

An option (sometimes called a "flag" or "switch") modifies the behavior of a command. Options are additional specifiers that tell the command how to operate differently from its default behavior. They can be short (preceded by a single hyphen, -) or long (preceded by a double hyphen, --). For example:

• In git commit -m "Your message", -m is a short option for --message that tells git commit to immediately follow with a commit message, which is provided in quotes.
• In ls -l, -l is an option for the ls command that modifies the output to be detailed (long listing format).

Options typically require a hyphen (-) or double hyphen (--) to distinguish them from the command or other types of input like filenames or other parameters. They can also sometimes require or allow additional values to be set, like in -m "Your message" where "Your message" is the value associated with the -m option.

Installation

gflags

git clone https://github.com/gflags/gflags
cd gflags
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DCMAKE_INSTALL_PREFIX:PATH=~/usr 
cmake --build build -j8
cmake --install build 

glog

git clone https://github.com/google/glog
cd glog
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DCMAKE_INSTALL_PREFIX:PATH=~/usr 
cmake --build build -j8
cmake --install build 

Google Falgs

Commandline Flag and Commandline Argument

Commandline flags: start with - for example -l or -f. -l takes no argument, and -f takes a string (/path/to/file) as an argument.

Commandline arguments: mumbo and jumbo, which don't start with a dash commandline arguments.

grep -l -f /path/to/file mumbo jumbo

Within a single source-code file that defines and use flags that are meaningful to that file, any application that links in that file will get the flags, and the gflags library will automatically handle that flag appropriately.

Defining Flags In Program

Just use the appropriate macro for the type you want the flag:

DEFINE_<variable_type>(name, default_value, "help text");

variable_type could be:

• DEFINE_bool: boolean
• DEFINE_int32: 32-bit integer
• DEFINE_int64: 64-bit integer
• DEFINE_uint64: unsigned 64-bit integer
• DEFINE_double: double
• DEFINE_string: C++ string

Example:

DEFINE_string(languages, "english,french,german", "comma-separated list of languages to offer in the 'lang' menu");

Accessing the Flag

Defined flags are available to the program as just a normal variable, with the prefix FLAGS_. For example:

  if (FLAGS_languages.find("finnish") != string::npos)
     HandleFinnish();

Sanity Checking Flag Values

After DEFINE-ing a flag, you may optionally register a validator function with the flag

static bool ValidatePort(const char* flagname, int32 value) {
   if (value > 0 && value < 32768)   // value is ok
     return true;
   printf("Invalid value for --%s: %d\n", flagname, (int)value);
   return false;
}
DEFINE_int32(port, 0, "What port to listen on");
DEFINE_validator(port, &ValidatePort);

Putting It Together

First you need to call

gflags::ParseCommandLineFlags(&argc, &argv, true);

you can add your custome help message:

gflags::SetUsageMessage("my custom help msg with --help");

You can pass the flags for DEFINE_string(languages, "english,french,german", "comma-separated list of languages to offer in the 'lang' menu"); in one of the following forms:

./main --languages="chinese,japanese,korean"
./main -languages="chinese,japanese,korean"
./main --languages "chinese,japanese,korean"
./main -languages "chinese,japanese,korean"

For the boolean flag DEFINE_bool(big_menu, true, "Include 'advanced' options in the menu listing");, the possibilities are slightly different:

./main --big_menu
./main --nobig_menu
./maino --big_menu=true
./main --big_menu=false

Special Flags

There are a few flags defined by the commandlineflags module itself. to see the complete list just use --help

1. Reporting flags:

• --help
• --helpxml

2. Flags that affect how other flags are parsed:

• --undefok=flagname,flagname

For those names listed as the argument to --undefok, suppress the normal error-exit that occurs when --name is seen on the commandline, but name has not been DEFINED anywhere in the application

3. Recursive Flags: cause other flag values to be set:

• --fromenv
• --tryfromenv
• --flagfile

Google Log

TOC generated with markdown-toc

Refs: 1