nl:: ArgParser

কমান্ড লাইন-স্টাইল আর্গুমেন্টের একটি সেট পার্স করুন, প্রতিটি অপশন এবং অ-অপশন আর্গুমেন্ট প্রক্রিয়া করার জন্য হ্যান্ডলিং ফাংশনকে কল করুন।

ParseArgs() আর্গুমেন্টের একটি তালিকা নেয় ( argv ) এবং সরবরাহকৃত বিকল্প সংজ্ঞাগুলির একটি সেট অনুসারে তাদের পার্স করে। ফাংশনটি দীর্ঘ (অপ্ট) এবং সংক্ষিপ্ত (-ও) উভয় বিকল্পকে সমর্থন করে এবং GNU getopt_long(3) ফাংশনের মতো একই বিকল্প সিনট্যাক্স প্রয়োগ করে।

OptionSet স্ট্রাকচার ( optSets ) এর একটি অ্যারে হিসাবে বিকল্প সংজ্ঞা ParseArgs()-এ পাস করা হয়। প্রতিটি অপশনসেটে বিকল্প সংজ্ঞা এবং একটি হ্যান্ডলার ফাংশনের একটি অ্যারে রয়েছে। ParseArgs() প্রদত্ত ক্রমে বিকল্প আর্গুমেন্ট প্রক্রিয়া করে, প্রতিটি স্বীকৃত বিকল্পের জন্য সংশ্লিষ্ট হ্যান্ডলার ফাংশনকে কল করে। সমস্ত বিকল্প পার্স করা হয়ে গেলে, একটি পৃথক নন-অপশন হ্যান্ডলার ফাংশন ( nonOptArgHandler ) যেকোন অবশিষ্ট আর্গুমেন্ট প্রক্রিয়া করার জন্য একবার কল করা হয়।

বিকল্প সেট

একটি OptionSet-এ একটি হ্যান্ডলার ফাংশনের একটি পয়েন্টার সহ বিকল্প সংজ্ঞাগুলির একটি সেট থাকে যা সংশ্লিষ্ট বিকল্পগুলির একটির সম্মুখীন হলে কল করা হবে। বিকল্প সেটগুলিতে প্রতিটি বিকল্পের সিনট্যাক্স এবং উদ্দেশ্য বর্ণনা করে সহায়তা পাঠ্যও থাকে (নীচে বিকল্প সহায়তা দেখুন)। বিকল্প সেটগুলি সম্পর্কিত বিকল্পগুলির পুনরায় ব্যবহারযোগ্য সংগ্রহ তৈরি করার অনুমতি দেওয়ার জন্য ডিজাইন করা হয়েছে। এটি একই ধরনের বিকল্প গ্রহণ করে এমন একাধিক অ্যাপ্লিকেশন বজায় রাখার জন্য প্রয়োজনীয় প্রচেষ্টাকে সহজ করে তোলে (যেমন পরীক্ষার অ্যাপ্লিকেশন)।

OptionSetsone সংজ্ঞায়িত করার জন্য দুটি প্যাটার্ন আছে হয় OptionSet স্ট্রাকচারের একটি ইনস্ট্যান্স শুরু করতে পারে, যেমন একটি স্ট্যাটিক গ্লোবাল হিসাবে, অথবা সাবক্লাস OptionSetBase এবং একটি কনস্ট্রাক্টর প্রদান করতে পারে। পরেরটি একটি বিশুদ্ধ ভার্চুয়াল HandleOption() ফাংশন ব্যবহার করে অপশন হ্যান্ডলিং সাবক্লাসে অর্পণ করে।

OptionSets তালিকাগুলি ParseArgs() ফাংশনে একটি NULL-টার্মিনেটেড অ্যারে পয়েন্টার হিসাবে পাঠানো হয়। যেমন:

static OptionSet gToolOptions =
{
    HandleOption,        // handler function
    gToolOptionDefs,  // array of option definitions
    "GENERAL OPTIONS",   // help group
    gToolOptionHelp   // option help text
};

static OptionSet *gOptionSets[] =
{
    &gToolOptions,
    &gNetworkOptions,
    &gTestingOptions,
    &gHelpOptions,
    NULL
};

int main(int argc, char *argv[])
{
    if (!ParseArgs("test-app", argc, argv, gOptionSets))
    {
        ...
    }
}

বিকল্প সংজ্ঞা

বিকল্পগুলি OptionDef কাঠামো ব্যবহার করে সংজ্ঞায়িত করা হয়। বিকল্পের সংজ্ঞাগুলি OptionDef উপাদানগুলির একটি অ্যারে হিসাবে সংগঠিত হয়, যেখানে প্রতিটি উপাদান থাকে: বিকল্পের নাম, একটি পূর্ণসংখ্যা আইডি যা বিকল্পটি সনাক্ত করতে ব্যবহৃত হয় এবং বিকল্পটি একটি আর্গুমেন্ট আশা করে/অনুমতি দেয় কিনা। বিকল্প অ্যারের শেষ একটি NULL নাম ক্ষেত্র দ্বারা সংকেত হয়। যেমন:

enum
{
    kOpt_Listen = 1000,
    kOpt_Length,
    kOpt_Count,
};

static OptionDef gToolOptionDefs[] =
{
    // NAME         REQUIRES/ALLOWS ARG?  ID/SHORT OPTION CHAR
    // ============================================================
    {  "listen",    kNoArgument,          kOpt_Listen     },
    {  "length",    kArgumentRequired,    kOpt_Length     },
    {  "count",     kArgumentRequired,    kOpt_Count      },
    {  "num",       kArgumentRequired,    kOpt_Count      }, // alias for --count
    {  "debug",     kArgumentOptional,    'd'             },
    {  "help",      kNoArgument,          'h'             },
    {  NULL }
};

বিকল্প আইডি

অপশন আইডি কোডের বিকল্পগুলিকে চিহ্নিত করে যা সেগুলি পরিচালনা করে (অপশনহ্যান্ডলার ফাংশন)। অপশন আইডিগুলি সেই অপশনসেটের সাথে আপেক্ষিক যেটিতে সেগুলি উপস্থিত হয় এবং এইভাবে বিভিন্ন অপশনসেট জুড়ে পুনরায় ব্যবহার করা যেতে পারে (তবে নিচে ছোট বিকল্পগুলি দেখুন)৷ সাধারণ নিয়ম হল 1000-এ নম্বর দেওয়া বিকল্প আইডি শুরু করা, তবে যেকোনো সংখ্যা > 128 ব্যবহার করা যেতে পারে। বিভিন্ন অপশন নামের একই অপশন আইডি ব্যবহার করে উপনাম অপশন তৈরি করা যায়।

সংক্ষিপ্ত বিকল্প

getopt_long(3) এর বিপরীতে, ParseArgs() সংক্ষিপ্ত বিকল্প অক্ষরের তালিকা নির্দিষ্ট করে একটি পৃথক স্ট্রিং নেয় না। বরং, যেকোনো বিকল্প যার আইডি মান গ্রাফিকাল ASCII অক্ষরের পরিসরে পড়ে সেই অক্ষরটিকে একটি সংক্ষিপ্ত বিকল্প হিসাবে ব্যবহার করার অনুমতি দেবে।

ParseArgs() এর জন্য প্রয়োজন যে সংক্ষিপ্ত বিকল্প অক্ষরগুলি সমস্ত OptionSets জুড়ে অনন্য। এই কারণে, সংঘর্ষের উল্লেখযোগ্য সুযোগের কারণে প্রোগ্রাম জুড়ে শেয়ার করা যেকোন অপশনসেটের জন্য সংক্ষিপ্ত বিকল্পের ব্যবহার নিরুৎসাহিত করা হয়। সংক্ষিপ্ত বিকল্প অক্ষর একটি একক OptionSet মধ্যে পুনঃব্যবহার করা যেতে পারে উপনাম দীর্ঘ বিকল্প নাম তৈরির জন্য অনুমতি দিতে।

বিকল্প সাহায্য

প্রতিটি OptionSet-এ একটি OptionHelp স্ট্রিং থাকে যা সংশ্লিষ্ট বিকল্পগুলির উদ্দেশ্য এবং সিনট্যাক্স বর্ণনা করে। এই স্ট্রিংগুলি PrintOptionHelp() ফাংশন দ্বারা বিকল্প ব্যবহারের তথ্য তৈরি করতে ব্যবহার করা হয়।

নিয়ম অনুসারে, বিকল্প সাহায্যের স্ট্রিংগুলি বিকল্পের পাঠ্য বিবরণ দ্বারা অনুসরণ করে একটি সিনট্যাক্স উদাহরণ নিয়ে গঠিত। যদি বিকল্পটির একটি সংক্ষিপ্ত সংস্করণ বা একটি উপনাম থাকে তবে এটি প্রাথমিক দীর্ঘ নামের আগে দেওয়া হয়। সামঞ্জস্যের জন্য, সিনট্যাক্স লাইনগুলি 2টি স্পেস দিয়ে ইন্ডেন্ট করা হয়, যখন বর্ণনা লাইনগুলি 7টি স্পেস দিয়ে ইন্ডেন্ট করা হয়। একটি একক ফাঁকা লাইন প্রতিটি বিকল্পের বিবরণ অনুসরণ করে, শেষটি সহ।

যেমন:

static const char *const gToolOptionHelp =
    "  --listen\n"
    "       Listen and respond to requests sent from another node.\n"
    "\n"
    "  --length \n"
    "       Send requests with the specified number of bytes in the payload.\n"
    "\n"
    "  --num, --count \n"
    "       Send the specified number of requests and exit.\n"
    "\n"
    "  -d, --debug []\n"
    "       Set debug logging to the given level. (Default: 1)\n"
    "\n"
    "  -h, --help\n"
    "       Print help information.\n"
    "\n";

বিকল্প সাহায্য গ্রুপ

OptionSets-এ একটি HelpGroupName স্ট্রিং থাকে যা সাহায্য আউটপুটে একসাথে বিকল্পগুলিকে গোষ্ঠীভুক্ত করতে ব্যবহৃত হয়। PrintOptionHelp() ফাংশন জেনারেট করা ব্যবহার আউটপুটে একটি বিভাগের শিরোনাম হিসাবে HelpGroupName ব্যবহার করে। যদি একাধিক OptionSets-এর একই HelpGroupName থাকে, PrintOptionHelp() একটি সাধারণ বিভাগের শিরোনামের অধীনে একসাথে বিভিন্ন OptionSets-এর জন্য বিকল্প সাহায্য প্রিন্ট করবে।

পার্সআর্গস

bool ParseArgs(
  const char *progName,
  int argc,
  char *argv[],
  OptionSet *optSets[]
)

bool ParseArgsFromEnvVar(
  const char *progName,
  const char *varName,
  OptionSet *optSets[],
  NonOptionArgHandlerFunct nonOptArgHandler,
  bool ignoreUnknown
)

bool ParseArgsFromEnvVar(
  const char *progName,
  const char *varName,
  OptionSet *optSets[]
)

bool ParseArgsFromEnvVar(
  const char *progName,
  const char *varName,
  OptionSet *optSets[],
  NonOptionArgHandlerFunct nonOptArgHandler
)

bool ParseArgsFromString(
  const char *progName,
  const char *argStr,
  OptionSet *optSets[],
  NonOptionArgHandlerFunct nonOptArgHandler,
  bool ignoreUnknown
)

--listen --count 10 --sw-version '1.0 (DEVELOPMENT)' "--hostname=nest.com"

bool ParseArgsFromString(
  const char *progName,
  const char *argStr,
  OptionSet *optSets[],
  NonOptionArgHandlerFunct nonOptArgHandler
)

bool ParseArgsFromString(
  const char *progName,
  const char *argStr,
  OptionSet *optSets[]
)

bool ParseBoolean(
  const char *str,
  bool & output
)

bool ParseFabricId(
  const char *str,
  uint64_t & fabricId,
  bool allowReserved
)

bool ParseHexString(
  const char *hexStr,
  uint32_t strLen,
  uint8_t *outBuf,
  uint32_t outBufSize,
  uint32_t & outDataLen
)

bool ParseIPAddress(
  const char *str,
  IPAddress & output
)

bool ParseInt(
  const char *str,
  uint64_t & output,
  int base
)

bool ParseInt(
  const char *str,
  uint32_t & output,
  int base
)

bool ParseInt(
  const char *str,
  int32_t & output,
  int base
)

bool ParseInt(
  const char *str,
  uint64_t & output
)

bool ParseInt(
  const char *str,
  uint32_t & output
)

bool ParseInt(
  const char *str,
  int32_t & output
)

bool ParseInt(
  const char *str,
  uint16_t & output
)

bool ParseInt(
  const char *str,
  int16_t & output
)

bool ParseInt(
  const char *str,
  uint8_t & output
)

bool ParseNodeId(
  const char *str,
  uint64_t & nodeId
)

bool ParseSubnetId(
  const char *str,
  uint16_t & subnetId
)

void PrintOptionHelp(
  OptionSet *optSets[],
  FILE *s
)

void PutStringWithBlankLine(
  FILE *s,
  const char *str
)

void PutStringWithNewLine(
  FILE *s,
  const char *str
)

int32_t SplitArgs(
  char *argStr,
  char **& argList,
  char *initialArg
)