genparse - מקוון בענן

תָכְנִית:

שֵׁם

genparse - מחולל מנתח שורת פקודה

תַקצִיר

genparse [אפשרויות] קבצים...

תיאור

genparse הוא מחולל מנתח שורת פקודה גנרי. מפשוט ותמציתי
קובץ המפרט, אתה יכול להגדיר את הפרמטרים והמתגים של שורת הפקודה
אוהב להיות מסוגל לעבור לתוכנית שלך. Genparse יוצר את קוד C, C++ או Java של
מנתח עבורך.

Genparse מניח שהגנו getopt_long(3) הפונקציה מובנית בספריית ה-C שלך. ל
Java ייתכן שתצטרך לציין קובץ jar מתאים למהדר Java שלך.

אפשרויות

genparse מקבל את האפשרויות הבאות:

-c, --cppext הארכה
סיומת קובץ C++. (ברירת מחדל = cc)

-d הפעל רישום.

-f, --קובץ לוג שם
שם קובץ יומן. (ברירת מחדל = genparse.log)

-h, - עזרה
הצג מידע עזרה.

-g, --גנוליב
השתמש בספריית התאימות של GNU (Gnulib, ראה http://www.gnu.org/software/gnulib/).
זמין רק עבור פלט C. מאפשר כמה סוגים נוספים (לא חתום ארוך, intmax_t וכו')
שעבורו Gnulib מספקת פונקציות המרה.

-i, --ללאומין
שים מאקרו בינלאומי _() סביב פלט טקסט כך שהתוכנית שנוצרה
ניתן לבינלאומי באמצעות פקודת GNU gettext. כרגע רק מיושם
עבור פלט C.

-l, --שפה lang
שפת פלט. רק C, C++ ו-Java נתמכות. כל אחד מהבאים
ציין C++: "c++", "cpp", "cc" ו-"cxx". לשימוש ב-Java: "java" או "Java".
(ברירת מחדל = c)

-o, --תיק שם
שם קובץ פלט. (ברירת מחדל = parse_cl)

-m, --חברים ארוכים
השתמש באפשרויות ארוכות עבור חברי מחלקת המנתח (struct). ברירת המחדל היא ל
השתמש בייצוג הקצר למעט אם יש רק ייצוג ארוך מוגדר
בקובץ genparse. אם אפשרות זו מוגדרת, ההתנהגות תבוטל. ה
ייצוג ארוך משמש אז למעט אם יש רק ייצוג קצר
מוּגדָר.

-o, --תיק שם הקובץ
שם השורש של קובץ הפלט. ההרחבה תיקבע לפי שפת הפלט
ואולי על ידי אפשרויות אחרות. לדוגמה, כאשר שפת הפלט היא C, נתינה
אפשרות זו ארגומנט של "קובץ" יביא לשמות קבצי פלט של "file.h",
"file.c" ו-"file_cb.c" עבור קבצי הכותרת, המנתח והקריאה חוזרת, בהתאמה.
ערך ברירת המחדל הוא "parse_cl".

-p, --parsefunc func
שם פונקציית ניתוח / מחלקה. אפשרות זו מאפשרת למשתמש לציין את השם
של הפונקציה (עבור C) או מחלקה (עבור C++ ו-Java) שעושה את הפקודה בפועל
ניתוח שורה (ברירת מחדל = "Cmdline").

-P, - הדפסות רבות
פלט טקסט עזרה עבור כל פרמטר שורת פקודה בפקודת הדפסה נפרדת.

-q, --שֶׁקֶט
מצב שקט - אין פלט על המסך.

-s, --כותרות סטטיות
שמור את הכותרת התיאורית על גבי הקבצים שנוצרו סטטית. בלי זה
אפשרות genparse מדפיס תאריך ושעה ליצירה, גרסת ליבת לינוקס, בניית ליבה
זמן, שם ארכיטקטורת מחשב, שם מארח ושם משתמש.

-v, --גִרְסָה
גרסת פלט.

-D, --מַדרִיך
ספרייה לאחסון תוצאות.

קלט קובץ

קובץ מפרט genparse (בדרך כלל נקרא רק 'קובץ genparse') מורכב ממספר
של ערכים, אחד לכל פרמטר שורת פקודה, בטופס:

short_names[*|!] [/ שם ארוך[*|!][=opt_name]] סוג [ אפשרויות ]

A שם קצר הוא תו בודד (קטן או גדול) או ספרה בודדת. שם ארוך הוא
שם אפשרות ארוך יותר (תיאורי יותר). בשורת הפקודה יקודם שם קצר
על ידי מקף בודד (למשל '-a') ולגרסה ארוכה יקדמו שני מקפים (למשל
'--את כל'). אם אין צורך בשם פרמטר ארוך, אתה יכול לציין רק את הקצר
(והלוכסן אינו צריך להופיע). על מנת לציין פרמטר שיש לו רק ארוך
סט שם short_names ל אף לא אחד. אפשר לקבל מספר אפשרויות קצרות, כך עבור
הגדרה לדוגמה שם קצר ל'aA' ו שם ארוך ל'כל' יאפשר לציין את
מתג שורת הפקודה בתור '-a' או '-A' או '--all', כולם עושים את אותו הדבר.

A * לאחר שם קצר or שם ארוך הופך את הטיעון לאופציונלי. ניתן לציין זאת עבור
אפשרויות קצרות וארוכות בנפרד.

A ! לאחר שם קצר or שם ארוך הופך את האופציה לבוליאנית. זה מאפשר לשלב א
אפשרות קצרה בוליאני עם אפשרות ארוכה עם ארגומנט אופציונלי או חובה או ל
שלב אופציה בוליאנית ארוכה עם אופציה קצרה עם ארגומנט אופציונלי או חובה.
A ! לא הגיוני אם סוג האופציה הוא דגל.

סוג חייב להיות אחד מהם int לצוף char מחרוזת or דגל. ארבעת הראשונים צריכים להיות עצמיים
מַסבִּיר. האחרונה היא אפשרות "בורר" שאינה לוקחת טיעונים. עבור פלט C ואם
--gnulib מוגדר בשורת הפקודה בנוסף מותרים הסוגים הבאים: ארוך
(לאורך זמן), אולונג (עבור אינט ארוך לא חתום), intmax (עבור intmax_t, מוגדר ב-Gnulib),
uintmax (עבור uintmax_t), לְהַכפִּיל.

הבא אפשרויות נתמכים. הם עשויים להופיע בכל סדר ולמעט
תיאורים ניתן להגדיר רק אחד מכל שדה לכל אפשרות.

A ברירת מחדל ערך עבור הפרמטר. עבור מחרוזת זו רק ברירת המחדל הפשוטה
ערך, מה שלא יהיה. עבור מחרוזות, יש לציין ברירת מחדל בתוך סוגרים ו
מרכאות, ועשויות לכלול רווח לבן, למשל {"ערך ברירת המחדל שלי"}. עבור char
פרמטר זה חייב להיות מוקף במירכאות בודדות, למשל 'a' או '\n'.

A רכס של ערכים בסוגריים. הערכים הנמוכים והגבוהים מצוינים בין א
מפרט טווח (או '...' או '..'). הערך הגבוה או הנמוך עשוי להיות
הושמט עבור טווח מוגבל בצד אחד בלבד. הפרמטר ייבדק אל
ודא שהוא נמצא בטווח זה.

A תתקשר בחזרה פונקציה. פונקציה זו נקראת לאחר כל בדיקת טווח
מְבוּצָע. מטרת ההתקשרות חזרה לעשות בדיקת תקפות היא יותר
מסובך ממה שניתן לציין בקובץ genparse. לדוגמה, אתה יכול
כתוב תוכנית שדורשת שהקלט יהיה מספרים ראשוניים, מחרוזות מסוימות
אורך וכו'.

A תיאור במירכאות כפולות. הוא מודפס על ידי נוֹהָג() פוּנקצִיָה. אם אחד
שורה לא מספיקה אז ציין מספר תיאורים, אחד בכל שורה וכל אחד מהם
אותם במירכאות כפולות. אם התיאור מתחיל בעמודה הראשונה ב-Genparse
לאחר מכן הוא יודפס גם בעמודה הראשונה ב- נוֹהָג() פונקציה.

A #gp_include ההנחיה תנחה את genparse לכלול קובץ genparse אחר,
לְמָשָׁל #gp_include אחר.gp. רק הגדרות פרמטרים מותרות בכלול
קובץ, ללא הנחיות גלובליות.

An __ERR_MSG__(err_txt) הוֹרָאָה. מציין את הודעת השגיאה שתודפס
כאשר לא ניתן היה להמיר את הטיעון. דוגמא: __ERR_MSG__("%s: חוקי
טַעֲנָה"). הודעה זו תודפס כאשר תפקוד ההמרה
נכשל או כאשר הטיעון היה מחוץ לטווח. מניח להכיל אחד %s אשר יהיה
יוחלף באגרומה שלא ניתן היה להמיר. זמין רק כאשר
Genparse מופעל עם --גנוליב, התעלמו אחרת.

לחלופין, ניתן להוסיף פונקציית המרה כארגומנט שני, למשל
__ERR_MSG__("%s: חוקי טַעֲנָה", quotearg). זה יוביל להודעת שגיאה
כמו שגיאה (EXIT_FAILURE, 0, "%s: חוקי טַעֲנָה", quotearg (optind)).

An __ADD_FLAG__ הוֹרָאָה. הגיוני רק אם פרמטר שורת הפקודה אינו
כבר דגל, במקרה זה נוסף פרמטר דגל נוסף שיהיה
הגדר אם פרמטר שורת הפקודה צוין בשורת הפקודה. אפשרות זו
מוגדר אוטומטית אם לפרמטר יש ארגומנט אופציונלי.

A __CODE__(הצהרות) הוֹרָאָה. הצהרות הקוד שצוינו מועתקות
פשוטו כמשמעו. דוגמא: __CODE__(printf ("פָּרָמֶטֶר x היה מַעֲרֶכֶת");). הקוד שצוין
יכול להשתרע על יותר מקו אחד. על מנת לתת לג'נפארס את ההזדמנות
הכנס את הקוד בצורה נכונה, אל תערבב רווחים וטאב באחד __קוד__
הצהרה.

A __STORE_LONGINDEX__ הוֹרָאָה. מורה ל-Genparse להוסיף שדה מסוג interer
למחלקת התוצאה שתוגדר למשתנה longindex (ארגומנט אחרון ב
הקריאה ל-@code{getopt_long()}). שדה חדש זה יקבל את אותו שם כמו ה-
שדה תוצאה שהוא קשור אליו אבל עם an _לי פוסט תיקון.

הבא גלוֹבָּלִי הנחיות נתמכים. הם עשויים להופיע בכל סדר.

An #include ההנחיה תנחה את genparse להעתיק את ההצהרה הכוללת האמורה
לתוך קוד C או C++ שנוצר על ידי genparse, אך לא קבצי כותרת או התקשרות חוזרת
קבצים.

A #חובה ניתן להשתמש ב-directive זה הופך את קריאות הפונקציה usage() לנחמדות יותר. זה מאפשר
עליך לציין פרמטרים חובה של שורת הפקודה שעשויים לעקוב אחר מתגים. הערה
ש-Genparse לא בודק פרמטרים חובה, הם מודפסים רק ב-
שימוש () לתפקד עם __חובה__ הוראה. הוצא משימוש: להוסיף מנדטורי
פרמטרים in מה היא #נוֹהָג סעיף במקום.

An #exit_value הוראה המציינת את ערך היציאה במקרה של שגיאה.
ברירת המחדל היא EXIT_FAILURE.

A #break_lines הנחיה המציינת את הרוחב שאליו ישברו קווים
במסך העזרה. אם לא #break_lines ההנחיה צוינה אז יהיו קווים
מודפס בדיוק כפי שניתן בקובץ genparse.

If #אין_מבנה צוין אז לא יוגדר struct אשר יתמלא ב
הפרמטרים של שורת הפקודה במנתח שנוצר. זה עשוי להיות שימושי אם אתה
רוצה להוסיף קוד משלך עם __קוד__ הצהרות במקום. נתמך רק עבור C
פלט.

A #export_long_options הוֹרָאָה. אם #export_long_options מוגדר אז א
פונקציה #get_long_options() נוסף אשר מייצא את מערך ה-longoptions בשימוש על ידי
#getopt_long(). הנחיה זו זמינה רק עבור פלט C, עבור שפות אחרות
מתעלמים ממנו.

A גלוֹבָּלִי תתקשר בחזרה פונקציה. פונקציה זו שימושית לבדיקת תלות הדדית
בין פרמטרים. לא ניתן לבדוק תלות הדדית בתוך כל אדם
פונקציית callback מכיוון שהסדר שבו ייקראו פונקציות אלו משתנה,
בהתאם לסדר הפרמטרים בשורת הפקודה.

Genparse גם יוצר א נוֹהָג() פונקציה שמדפיסה טקסט עזרה לסטdout על
שימוש בתוכנית שעבורה Genparse מייצר את המנתח. זה יכול להיות מותאם אישית על ידי
ציון קטע שימוש בתחתית קובץ Genparse. אם אין סעיף כזה
ציינו שזה כברירת מחדל

#שימוש_התחל
שימוש: __PROGRAM_NAME__ __OPTIONS_SHORT__ __חובה__
__מילון מונחים__
#usage_end

סעיף השימוש מתחיל ב #שימוש_התחל ומסתיים ב #usage_end. כל טקסט בין הוא
מודפס מילה במילה למעט מילות המפתח הבאות, שיוחלפו כמפורט
להלן:

__PROGRAM_NAME__: שם התוכנית. ב-C ו-C++ שם התוכנית ניתן ב
argv[0].

__OPTIONS_SHORT__: רשימה של אפשרויות זמינות של טופס קצר, למשל [ -abc ].

__חובה__: רשימה של כל הפרמטרים החובה כפי שהוגדרו עם #mandatory
פקודות. הוצא משימוש: רשימה מנדטורי פרמטרים כאן באופן ישיר.

__מילון מונחים__: תיאור של כל אפשרויות שורת הפקודה. זה המידע
ניתן עבור הגדרות הפרמטרים בצורה קריא אנושית. זה כולל את
סוג פרמטר, ברירת מחדל, טווח והערות כלשהן. שורה שמכילה
__מילון מונחים__ מוחלף על ידי מילון המונחים של הפרמטרים, כל טקסט אחר ב-
מתעלמים מאותה שורה.

__מילון מונחים_GNU__: כמו __מילון מונחים__ אבל בסגנון גנו. אופציונלי ואחריו an
מספר שלם בסוגריים המציין את ההזחה של הטקסט התיאורי (למשל
__מילון מונחים__(30)). הזחה ברירת המחדל היא 24.

__STRING__(ים): קבוע מחרוזת, ב-C כנראה מאקרו מחרוזת המוגדר עם
#define פקודת מעבד. ניתן לייבא מאקרו זה מקובץ אחר באמצעות
הוראת include בקובץ genparse. התעלמו בעת יצירת פלט Java.

__INT__(x): קבוע מספר שלם, ב-C כנראה מאקרו שלם המוגדר עם ה-
#define פקודת מעבד. ניתן לייבא מאקרו זה מקובץ אחר באמצעות
הוראת include בקובץ genparse. התעלמו בעת יצירת פלט Java.

__CODE__(הצהרות): זהה לאפשרויות הפרמטרים, ראה למעלה.

__DO_NOT_DOCUMENT__: כל שורה המכילה מאקרו זה לא תודפס ב-
נוֹהָג() פוּנקצִיָה. יכול לשמש ליישום פרמטרים של שורת הפקודה ללא
רישום אותם במסך העזרה.

__NL__: שורה חדשה. שימושי לשבירת קווים ידנית תוך שבירת קווים אוטומטית
פועל (ראה #break_lines). התעלמו בעת יצירת פלט Java.

__NEW_PRINT__: סגור את פקודת ההדפסה הפעילה והתחל פקודת חדשה.

__COMMENT__(טקסט): הערה בקוד להדפסת טקסט השימוש.

אופציות ארוכות יכולות להיות מלווה בסימן = וציון אופציונלי opt_name שיכול
להתייחס בתיאור הבא. זה ישמש ב נוֹהָג() פונקציה
רק. למשל שורת הגנפארזה הבאה

s / block-size=SIZE int "השתמש בלוקים של SIZE-byte"

יוביל לשורה הבאה במסך העזרה

[ -s ] [ --block-size=SIZE ] (סוג=INTEGER)
השתמש בלוקים של SIZE-byte

בסגנון גנפארס (__מילון מונחים__) או

-s, --block-size=SIZE השתמש בלוקים של SIZE-byte

בסגנון גנו (__מילון מונחים_GNU__).

אפשר גם לשים סוגרים מרובעים סביב השם האופציונלי על מנת לציין
שהטיעון הוא אופציונלי. עם זאת, אין לזה משמעות עבור המנתח שנוצר. להשתמש
* תיקוני פוסט על מנת להפוך ארגומנט לאופציונלי.

s* / block*[=SIZE] int "השתמש בלוקים."
"אם לא יינתן SIZE אז הם יקבלו גודל של 1kB."

יוביל לשורה הבאה במסך העזרה

-s, --block[=SIZE] השתמש בלוקים.
אם לא יינתן SIZE אז הם יקבלו גודל של 1kB.

דוגמא

הנה קובץ Genparse לדוגמה:

#לִכלוֹל

/* תגובה */
my_callback()

i / iterations int 100 [10...1000] iter_callback()
"מספר איטרציות לרוץ."

/*
* הערה
*/

n / name string {"mike"} name_cb() "שם המשתמש"
s / str string "מחרוזת בדיקה"
דגל f "דגל טיפש!"

#שימוש_התחל
שימוש: __PROGRAM_NAME__ __OPTIONS_SHORT__ שם קובץ
זו רק תוכנית מבחן מטופשת.
__מילון מונחים__
#usage_end

השתמש ב-genparse באינטרנט באמצעות שירותי onworks.net