SkFlagInfo Class Reference

#include <CommandLineFlags.h>

Public Types
enum	FlagTypes { kBool_FlagType , kString_FlagType , kInt_FlagType , kDouble_FlagType }

Public Member Functions
bool	match (const char *string)
FlagTypes	getFlagType () const
void	resetStrings ()
void	append (const char *string)
void	setInt (int value)
void	setDouble (double value)
void	setBool (bool value)
SkFlagInfo *	next ()
const SkString &	name () const
const SkString &	shortName () const
const SkString &	help () const
const SkString &	extendedHelp () const
SkString	defaultValue () const
SkString	typeAsString () const

Static Public Member Functions
static bool	CreateBoolFlag (const char *name, const char *shortName, bool *pBool, bool defaultValue, const char *helpString)
static bool	CreateStringFlag (const char *name, const char *shortName, CommandLineFlags::StringArray *pStrings, const char *defaultValue, const char *helpString, const char *extendedHelpString)
static bool	CreateIntFlag (const char *name, int *pInt, int defaultValue, const char *helpString)
static bool	CreateIntFlag (const char *name, const char *shortName, int *pInt, int defaultValue, const char *helpString)
static bool	CreateDoubleFlag (const char *name, double *pDouble, double defaultValue, const char *helpString)

Detailed Description

Definition at line 273 of file CommandLineFlags.h.

Member Enumeration Documentation

FlagTypes

enum SkFlagInfo::FlagTypes

Enumerator
kBool_FlagType
kString_FlagType
kInt_FlagType
kDouble_FlagType

Definition at line 275 of file CommandLineFlags.h.

                   {
        kBool_FlagType,
        kString_FlagType,
        kInt_FlagType,
        kDouble_FlagType,
    };

Member Function Documentation

append()

void SkFlagInfo::append ( const char *  string )

inline

Definition at line 382 of file CommandLineFlags.h.

                                    {
        if (kString_FlagType == fFlagType) {
            fStrings->append(string);
        } else {
            SkDEBUGFAIL("Can only append to kString_FlagType");
        }
    }

CreateBoolFlag()

static bool SkFlagInfo::CreateBoolFlag ( const char *  name, const char *  shortName, bool *  pBool, bool  defaultValue, const char *  helpString  )

inlinestatic

Each Create<Type>Flag function creates an SkFlagInfo of the specified type. The SkFlagInfo object is appended to a list, which is deleted when CommandLineFlags::Parse is called. Therefore, each call should be made before the call to ::Parse. They are not intended to be called directly. Instead, use the macros described above.

Parameters

name	Long version (at least 2 characters) of the name of the flag. This name can be referenced on the command line as "--name" to set the value of this flag.
shortName	Short version (one character) of the name of the flag. This name can be referenced on the command line as "-shortName" to set the value of this flag.
p<Type>	Pointer to a global variable which holds the value set by CommandLineFlags.
defaultValue	The default value of this flag. The variable pointed to by p<Type> will be set to this value initially. This is also displayed as part of the help output.
helpString	Explanation of what this flag changes in the program.

Definition at line 296 of file CommandLineFlags.h.

                                                       {
        SkFlagInfo* info  = new SkFlagInfo(name, shortName, kBool_FlagType, helpString, nullptr);
        info->fBoolValue  = pBool;
        *info->fBoolValue = info->fDefaultBool = defaultValue;
        return true;
    }

CreateDoubleFlag()

static bool SkFlagInfo::CreateDoubleFlag ( const char *  name, double *  pDouble, double  defaultValue, const char *  helpString  )

inlinestatic

See comments for CreateBoolFlag.

Definition at line 347 of file CommandLineFlags.h.

                                                         {
        SkFlagInfo* info    = new SkFlagInfo(name, nullptr, kDouble_FlagType, helpString, nullptr);
        info->fDoubleValue  = pDouble;
        *info->fDoubleValue = info->fDefaultDouble = defaultValue;
        return true;
    }

CreateIntFlag() [1/2]

static bool SkFlagInfo::CreateIntFlag ( const char *  name, const char *  shortName, int *  pInt, int  defaultValue, const char *  helpString  )

inlinestatic

Definition at line 333 of file CommandLineFlags.h.

                                                      {
        SkFlagInfo* info = new SkFlagInfo(name, shortName, kInt_FlagType, helpString, nullptr);
        info->fIntValue  = pInt;
        *info->fIntValue = info->fDefaultInt = defaultValue;
        return true;
    }

CreateIntFlag() [2/2]

static bool SkFlagInfo::CreateIntFlag ( const char *  name, int *  pInt, int  defaultValue, const char *  helpString  )

inlinestatic

See comments for CreateBoolFlag.

Definition at line 323 of file CommandLineFlags.h.

                                                      {
        SkFlagInfo* info = new SkFlagInfo(name, nullptr, kInt_FlagType, helpString, nullptr);
        info->fIntValue  = pInt;
        *info->fIntValue = info->fDefaultInt = defaultValue;
        return true;
    }

CreateStringFlag()

bool SkFlagInfo::CreateStringFlag ( const char *  name, const char *  shortName, CommandLineFlags::StringArray *  pStrings, const char *  defaultValue, const char *  helpString, const char *  extendedHelpString  )

static

See comments for CreateBoolFlag.

Parameters

pStrings	Unlike the others, this is a pointer to an array of values.
defaultValue	Thise default will be parsed so that strings separated by spaces will be added to pStrings.

Definition at line 16 of file CommandLineFlags.cpp.

                                                                                     {
    SkFlagInfo* info =
            new SkFlagInfo(name, shortName, kString_FlagType, helpString, extendedHelpString);
    info->fDefaultString.set(defaultValue);
 
    info->fStrings = pStrings;
    SetDefaultStrings(pStrings, defaultValue);
    return true;
}

defaultValue()

SkString SkFlagInfo::defaultValue ( ) const

inline

Definition at line 423 of file CommandLineFlags.h.

                                  {
        SkString result;
        switch (fFlagType) {
            case SkFlagInfo::kBool_FlagType:
                result.printf("%s", fDefaultBool ? "true" : "false");
                break;
            case SkFlagInfo::kString_FlagType: return fDefaultString;
            case SkFlagInfo::kInt_FlagType: result.printf("%i", fDefaultInt); break;
            case SkFlagInfo::kDouble_FlagType: result.printf("%2.2f", fDefaultDouble); break;
            default: SkDEBUGFAIL("Invalid flag type");
        }
        return result;
    }

extendedHelp()

const SkString & SkFlagInfo::extendedHelp ( ) const

inline

Definition at line 421 of file CommandLineFlags.h.

{ return fExtendedHelpString; }

getFlagType()

FlagTypes SkFlagInfo::getFlagType ( ) const

inline

Definition at line 372 of file CommandLineFlags.h.

{ return fFlagType; }

help()

const SkString & SkFlagInfo::help ( ) const

inline

Definition at line 420 of file CommandLineFlags.h.

{ return fHelpString; }

match()

bool SkFlagInfo::match

(

const char *

string

)

Returns true if the string matches this flag. For a boolean flag, also sets the value, since a boolean flag can be set in a number of ways without looking at the following string: –name –noname –name=true –name=false –name=1 –name=0 –name=TRUE –name=FALSE

Definition at line 92 of file CommandLineFlags.cpp.

                                         {
    if (SkStrStartsWith(string, '-') && strlen(string) > 1) {
        string++;
        const SkString* compareName;
        if (SkStrStartsWith(string, '-') && strlen(string) > 1) {
            string++;
            // There were two dashes. Compare against full name.
            compareName = &fName;
        } else {
            // One dash. Compare against the short name.
            compareName = &fShortName;
        }
        if (kBool_FlagType == fFlagType) {
            // In this case, go ahead and set the value.
            if (compareName->equals(string)) {
                *fBoolValue = true;
                return true;
            }
            if (SkStrStartsWith(string, "no") && strlen(string) > 2) {
                string += 2;
                // Only allow "no" to be prepended to the full name.
                if (fName.equals(string)) {
                    *fBoolValue = false;
                    return true;
                }
                return false;
            }
            int equalIndex = SkStrFind(string, "=");
            if (equalIndex > 0) {
                // The string has an equal sign. Check to see if the string matches.
                SkString flag(string, equalIndex);
                if (flag.equals(*compareName)) {
                    // Check to see if the remainder beyond the equal sign is true or false:
                    string += equalIndex + 1;
                    parse_bool_arg(string, fBoolValue);
                    return true;
                } else {
                    return false;
                }
            }
        }
        return compareName->equals(string);
    }
 
    // Has no dash
    return false;
}

name()

const SkString & SkFlagInfo::name ( ) const

inline

Definition at line 416 of file CommandLineFlags.h.

{ return fName; }

next()

SkFlagInfo * SkFlagInfo::next ( )

inline

Definition at line 414 of file CommandLineFlags.h.

{ return fNext; }

resetStrings()

void SkFlagInfo::resetStrings ( )

inline

Definition at line 374 of file CommandLineFlags.h.

                        {
        if (kString_FlagType == fFlagType) {
            fStrings->reset();
        } else {
            SkDEBUGFAIL("Can only call resetStrings on kString_FlagType");
        }
    }

setBool()

void SkFlagInfo::setBool ( bool  value )

inline

Definition at line 406 of file CommandLineFlags.h.

                             {
        if (kBool_FlagType == fFlagType) {
            *fBoolValue = value;
        } else {
            SkDEBUGFAIL("Can only call setBool on kBool_FlagType");
        }
    }

setDouble()

void SkFlagInfo::setDouble ( double  value )

inline

Definition at line 398 of file CommandLineFlags.h.

                                 {
        if (kDouble_FlagType == fFlagType) {
            *fDoubleValue = value;
        } else {
            SkDEBUGFAIL("Can only call setDouble on kDouble_FlagType");
        }
    }

setInt()

void SkFlagInfo::setInt ( int  value )

inline

Definition at line 390 of file CommandLineFlags.h.

                           {
        if (kInt_FlagType == fFlagType) {
            *fIntValue = value;
        } else {
            SkDEBUGFAIL("Can only call setInt on kInt_FlagType");
        }
    }

shortName()

const SkString & SkFlagInfo::shortName ( ) const

inline

Definition at line 418 of file CommandLineFlags.h.

{ return fShortName; }

typeAsString()

SkString SkFlagInfo::typeAsString ( ) const

inline

Definition at line 437 of file CommandLineFlags.h.

                                  {
        switch (fFlagType) {
            case SkFlagInfo::kBool_FlagType: return SkString("bool");
            case SkFlagInfo::kString_FlagType: return SkString("string");
            case SkFlagInfo::kInt_FlagType: return SkString("int");
            case SkFlagInfo::kDouble_FlagType: return SkString("double");
            default: SkDEBUGFAIL("Invalid flag type"); return SkString();
        }
    }

---

The documentation for this class was generated from the following files:

• third_party/skia/tools/flags/CommandLineFlags.h
• third_party/skia/tools/flags/CommandLineFlags.cpp