نام (NAME)

bt_post_processing - پس‌پردازش رشته‌ها، مقادیر و مدخل‌های BibTeX

خلاصه دستور (SYNOPSIS)

void bt_postprocess_string (char * s,
                            btshort options)
char * bt_postprocess_value (AST *   value,
                             btshort  options, 
                             boolean replace);
char * bt_postprocess_field (AST *   field, 
                             btshort  options, 
                             boolean replace);
void bt_postprocess_entry (AST *  entry,
                           btshort options);

توضیحات (DESCRIPTION)

هنگامی که btparse یک مدخل BibTeX را تجزیه می‌کند، نتایج را در ابتدا در یک درخت نحو انتزاعی (AST)، به شکلی که دقیقاً بازتاب‌دهندهٔ داده‌های تجزیه‌شده است، ذخیره می‌نماید. برای مثال، مدخل

@Article{Jones:1997a,
  AuThOr = "Bob   Jones" # and # "Jim Smith ",
  TITLE = "Feeding Habits of
           the Common Cockroach",
  JoUrNaL = j_ent,
  YEAR = 1997
}

به یک AST تجزیه می‌شود که می‌تواند به صورت زیر نمایش داده شود:

(entry,"Article")
  (key,"Jones:1997a")
  (field,"AuThOr")
    (string,"Bob   Jones")
    (macro,"and")
    (string,"Jim Smith ")
  (field,"TITLE")
    (string,"Feeding Habits of               the Common Cockroach")
  (field,"JoUrNaL")
    (macro,"j_ent")
  (field,"YEAR")
    (number,"1997")

مزیت این قالب در این است که تمامی اطلاعات مهم مدخل با پیمایش درخت با استفاده از توابع شرح داده شده در bt_traversal به‌آسانی در دسترس هستند. اما مشکل آشکار این است که داده‌ها بیش از حد خام هستند و نمی‌توان بلافاصله از آن‌ها استفاده کرد: حروف بزرگ و کوچک در انواع مدخل‌ها و نام‌های فیلدها ناهماهنگ است، رشته‌ها پر از فاصله‌های خالی ناخواسته هستند، مقادیر فیلدها به یک رشتهٔ واحد تقلیل نیافته‌اند، و مواردی از این دست.

تمام این مشکلات توسط توابع پس‌پردازش btparse که در اینجا توضیح داده شده‌اند، برطرف می‌شوند. به‌طور معمول، نیازی به فراخوانی این توابع نخواهید داشت---کتابخانه پس از تجزیهٔ هر مدخل «کار درست» را برای شما انجام می‌دهد، و شما می‌توانید مشخص کنید که دقیقاً چه چیزی برای برنامهٔ شما «کار درست» است. (برای نمونه، می‌توانید به آن بگویید ماکروها را بسط دهد، اما زیررشته‌ها را به یکدیگر الحاق نکند.) با این حال، ممکن است بخواهید پس‌پردازش را به کد خود و خارج از کنترل کتابخانه منتقل کنید. محتمل‌تر این است که رشته‌هایی از جایی غیر از فایل‌های BibTeX داشته باشید و بخواهید با آن‌ها مانند رشته‌های BibTeX رفتار شود؛ در این شرایط، توابع پس‌پردازش ضروری هستند. در نهایت، ممکن است صرفاً کنجکاو باشید که پس از تجزیهٔ داده‌هایتان، دقیقاً چه بر سر آن‌ها می‌آید. اگر چنین است، برای دریافت توضیحاتی بسیار موشکافانه و دقیق به جای درستی آمده‌اید.

توابع (FUNCTIONS)

btparse چهار نقطهٔ ورود برای کد پس‌پردازش خود فراهم می‌کند. از میان این‌ها، احتمالاً تنها مورد اول و آخر---برای پردازش رشته‌های منفرد و کل مدخل‌ها---کاربرد متداول خواهند داشت.

نقاط ورود پس‌پردازش (Post-processing entry points)

برای درک چرایی ارائهٔ چهار نقطهٔ ورود، توضیحی دربارهٔ نمونه AST ارائه‌شده در بالا کمک‌کننده خواهد بود. پیش از هر چیز، کل مدخل توسط گره "(entry,"Article")" نمایش داده می‌شود؛ این گره کلید مدخل و تمام جفت‌های فیلد/مقدار آن را به عنوان فرزندان خود دارد. گره‌های مدخل توسط bt_parse_entry() و bt_parse_entry_s() (نگاه کنید به bt_input) و همچنین bt_next_entry() (که فهرستی از مدخل‌های بازگردانده شده از bt_parse_file() را پیمایش می‌کند---نگاه کنید به bt_traversal) برگردانده می‌شوند. کل مدخل‌ها را می‌توان با bt_postprocess_entry() پس‌پردازش کرد.

همچنین ممکن است نیاز به پس‌پردازش یک فیلد منفرد، یا صرفاً مقدار مرتبط با آن داشته باشید. (تفاوت در این است که پردازش فیلد علاوه بر مقدار فیلد، می‌تواند نام فیلد را نیز---برای مثال به حروف کوچک---تغییر دهد.) گره "(field,"AuThOr")" در بالا نمونه‌ای از یک زیر-AST فیلد است، و "(string,"Bob Jones")" نخستین گره در فهرست مقادیر ساده است که مقدار آن فیلد را نمایش می‌دهد. (به یاد داشته باشید که مقدار یک فیلد، به‌طور کلی، فهرستی از مقادیر ساده است.) گره‌های فیلد توسط bt_next_field() و گره‌های مقدار توسط bt_next_value() برگردانده می‌شوند. مورد اول را می‌توان برای پس‌پردازش به bt_postprocess_field() و مورد دوم را به bt_postprocess_value() ارسال کرد.

در نهایت، رشته‌های منفرد ممکن است از جاهای متعددی غیر از یک AST در btparse وارد برنامهٔ شما شوند. به همین دلیل، bt_postprocess_string() برای پس‌پردازش رشته‌های دلخواه در دسترس است.

گزینه‌های پس‌پردازش (Post-processing options)

تمام توابع پس‌پردازش دارای پارامتر "options" هستند که می‌توانید از آن برای تنظیم دقیق پس‌پردازش استفاده کنید. (این دقیقاً مانند گزینه‌های پردازش رشته به ازای هر متاتایپ است که می‌توانید پیش از تجزیهٔ مدخل‌ها تنظیم کنید؛ نگاه کنید به bt_set_stringopts() در bt_input.) مانند جاهای دیگر کتابخانه، "options" یک نگاشت بیتی (bitmap) است که از OR کردن ثوابت مختلف از پیش تعریف‌شده با یکدیگر ساخته می‌شود. این ثوابت و تأثیرات آن‌ها در بخش "String processing option macros" در btparse مستند شده‌اند.

bt_postprocess_string ()

void bt_postprocess_string (char * s,
                            btshort options)

یک رشتهٔ منفرد، "s" را درجا تغییر داده و پس‌پردازش می‌کند. تنها گزینهٔ پس‌پردازش که برای رشته‌های منفرد معنی دارد، فشرده‌سازی فاصله‌های خالی طبق قوانین BibTeX است؛ بنابراین، اگر "options & BTO_COLLAPSE" نادرست (false) باشد، این تابع اثری نخواهد داشت. (اگرچه در هر صورت یک دور کامل روی رشته پیمایش می‌کند؛ این امر برای توسعه در آینده است.)

قوانین دقیق فشرده‌سازی فاصله‌های خالی ساده هستند: نویسه‌های فاصلهٔ خالی غیر از space (عمدتاً تب‌ها و خطوط جدید) به space تبدیل می‌شوند، هر توالی بیش از یک space در میان متن به یک space واحد فشرده می‌شود، و تمام فاصله‌های آغازین یا پایانی حذف می‌گردند. (اطمینان از اینکه تمامی فاصله‌های خالی نویسهٔ space باشند در واقع توسط پویشگر واژگانی btparse انجام می‌شود، بنابراین رشته‌ها در ASTهای btparse هرگز فاصله‌ای جز space نخواهند داشت. به همین ترتیب، هر رشته‌ای که به bt_postprocess_string() ارسال می‌شود نباید شامل نویسه‌های فاصلهٔ خالی غیر از space باشد.)

bt_postprocess_value ()

char * bt_postprocess_value (AST *   value,
                             btshort  options, 
                             boolean replace);

یک مقدار فیلد منفرد را پس‌پردازش می‌کند که سرِ فهرستی از مقادیر سادهٔ بازگردانده شده توسط bt_next_value() است. تمامی گزینه‌های مرتبط با پردازش رشته در اینجا وارد عمل می‌شوند: تبدیل اعداد به رشته‌ها ("BTO_CONVERT")، بسط ماکروها ("BTO_EXPAND")، فشرده‌سازی فاصله‌های خالی ("BTO_COLLAPSE")، و چسباندن رشته‌ها ("BTO_PASTE"). از آنجا که چسباندن زیررشته‌ها به یکدیگر بدون بسط اولیهٔ ماکروها و تبدیل اعداد بی‌معنی است، تلاش برای انجام این کار یک خطای مهلک است.

اگر "replace" درست (true) باشد، فهرستی که "value" در رأس آن است با فهرستی جایگزین می‌شود که مقدار پردازش‌شده را نشان می‌دهد. بدین معنا که اگر چسباندن رشته فعال باشد ("options & BTO_PASTE" درست باشد)، این فهرست به یک گرهٔ واحد فشرده خواهد شد که حاوی رشتهٔ منفرد حاصل از چسباندن تمام زیررشته‌ها است. اگر چسباندن رشته فعال نباشد، هر گره در فهرست دست‌نخورده باقی می‌ماند، اما متن آن با متن پردازش‌شده جایگزین می‌شود.

اگر "replace" نادرست (false) باشد، یک رشتهٔ جدید در لحظه ساخته شده و توسط تابع بازگردانده می‌شود. توجه داشته باشید که اگر چسباندن در این حالت فعال نباشد، شما فقط آخرین رشته در فهرست را دریافت خواهید کرد. (هرچند پس‌پردازش یک مقدار بدون چسباندن چندان معقول نیست، مگر اینکه بخواهید آن را با مقدار جدید جایگزین کنید.)

رشتهٔ حاصل از پردازش کل مقدار را بازمی‌گرداند؛ این بازگشت تنها در حالتی معنادار است که چسباندن فعال بوده باشد یا فقط یک مقدار در فهرست وجود داشته باشد. اگر یک فهرست چندمقداری بدون چسباندن پردازش شود، آخرین رشته در فهرست (پس از پردازش) بازگردانده می‌شود.

بررسی کنید که چه کاری می‌توان روی مقدار فیلد "author" در مثال بالا انجام داد، که الحاقی از یک رشته، یک ماکرو و یک رشتهٔ دیگر است. فرض کنید که ماکروی "and" به " and " بسط می‌یابد، و متغیر "value" به زیر-AST این مقدار اشاره می‌کند. زیر-AST اصلی متناظر با این مقدار به این صورت است:

(string,"Bob   Jones")
(macro,"and")
(string,"Jim Smith ")

برای پردازش کامل این مقدار درجا (in-place)، دستور زیر را فراخوانی می‌کنید:

bt_postprocess_value (value, BTO_FULL, TRUE);

("BTO_FULL" صرفاً ترکیبی از تمام گزینه‌های ممکن پردازش رشته است: "BTO_CONVERT|BTO_EXPAND|BTO_PASTE|BTO_COLLAPSE".) این کار مقدار را به یک فهرست تک‌عنصری تبدیل می‌کند:

(string,"Bob Jones and Jim Smith")

و رشتهٔ کاملاً پردازش‌شدهٔ "Bob Jones and Jim Smith" را بازمی‌گرداند. توجه داشته باشید که ماکروی "and" بسط یافته، میان دو رشتهٔ لفظی قرار گرفته، همه‌چیز به یکدیگر چسبانده شده، و در نهایت فاصله‌های خالی فشرده شده‌اند. (فشرده‌سازی فاصله‌های خالی پیش از الحاق رشته‌ها ایدهٔ بدی خواهد بود.)

فرض کنید ترجیح می‌دهید ماهیت فهرستی مقدار را حفظ کنید، در حالی که ماکروها بسط داده شده و هر عددی به رشته تبدیل شود. (این تبدیل ناچیز است: صرفاً نوع گره را از "BTAST_NUMBER" به "BTAST_STRING" تغییر می‌دهد. مقادیر «عددی» همواره به صورت رشته‌ای از ارقام ذخیره می‌شوند، درست همان‌طور که در فایل ظاهر می‌گردند.) این کار با فراخوانی زیر انجام می‌شود:

bt_postprocess_value
   (value, BTO_CONVERT|BTO_EXPAND|BTO_COLLAPSE,TRUE);

که فهرست را به این صورت تغییر می‌دهد:

(string,"Bob Jones")
(string,"and")
(string,"Jim Smith")

توجه داشته باشید که فاصله‌های خالی در اینجا پیش از امکان انجام هرگونه الحاق فشرده شده‌اند؛ این کار احتمالاً ایدهٔ بدی است. اما اگر بخواهید می‌توانید انجامش دهید. (اگر فکری به سرتان زده که با انجام گام‌های کوچک این‌چنینی روش پس‌پردازش مقدار مخصوص به خود را سرهم کنید، نگاهی به کد منبع bt_postprocess_value() بیندازید؛ این کار باید شما را از چنین مخاطره‌ای منصرف کند.)

bt_postprocess_field ()

char * bt_postprocess_field (AST *   field, 
                             btshort  options, 
                             boolean replace);

این تابع اساساً چیزی بیش از یک پیشانه (front-end) برای bt_postprocess_value() نیست؛ تنها تفاوت این است که یک گره AST از نوع «field» به آن ارسال می‌کنید (مانند "(field,"AuThOr")" در مثال بالا)، و اینکه این تابع علاوه بر مقدار فیلد، نام فیلد را نیز دگرگون می‌کند. به ویژه، نام فیلد به اجبار به حروف کوچک تبدیل می‌شود؛ این رفتار (در حال حاضر) اختیاری نیست.

رشتهٔ بازگردانده شده توسط bt_postprocess_value() را برمی‌گرداند.

bt_postprocess_entry ()

void bt_postprocess_entry (AST *  entry,
                           btshort options);

تمام مقادیر موجود در یک مدخل را پس‌پردازش می‌کند. اگر "entry" به AST یک مدخل «عادی» یا «تعریف ماکرو» اشاره کند، مقادیر دقیقاً همان چیزی هستند که انتظار دارید: هر آنچه در سمت راست «انتساب» یک فیلد یا ماکرو قرار دارد. با این حال، می‌توانید مدخل‌های comment و preamble را نیز پس‌پردازش کنید. مدخل‌های توضیح (comment) اساساً یک رشتهٔ بزرگ هستند، بنابراین تنها فشرده‌سازی فاصله‌های خالی برای آن‌ها معنا دارد. مدخل‌های preamble ممکن است چندین رشتهٔ چسبانده‌شده به یکدیگر داشته باشند، بنابراین تمام گزینه‌های پردازش رشته برای آن‌ها اعمال‌پذیر است. (و هیچ‌چیز مانع استفاده از ماکروها در یک preamble نمی‌شود.)