کلینگ فارمیٹ انڈینٹیشن کے ساتھ C++ چینڈ میتھڈ کالز کو کیسے سیدھ میں کریں۔

پرفیکٹ انڈینٹیشن کے لیے کلینگ فارمیٹ میں مہارت حاصل کرنا

ہر ڈویلپر صاف، پڑھنے کے قابل کوڈ کو پسند کرتا ہے، خاص طور پر جب اس کے ساتھ کام کریں۔ زنجیروں سے جڑی ہوئی کالز C++ میں۔ پھر بھی، ہم سب کو ایسے ٹولز کا سامنا کرنا پڑا ہے۔ clang-فارمیٹ جو کبھی کبھی کوڈ کو ہماری پسند کے مطابق سیدھ میں کرنے سے انکار کر دیتے ہیں۔ ایک عام چیلنج پچھلی لائن کے مقابلے میں خوبصورتی سے سیدھ میں لانے کے لیے زنجیروں سے جڑے طریقوں کا انڈینٹیشن حاصل کرنا ہے، نہ کہ ابتدائی فنکشن۔

تصور کریں کہ آپ بلڈر پیٹرن کے ساتھ ایک آبجیکٹ بنا رہے ہیں۔ آپ اس طرح صاف آؤٹ پٹ چاہتے ہیں:

آٹو foo = FooBuilder()
.WithSomething()
.WithSomethingElse()
.Build();

لیکن کلینگ فارمیٹ آپ کے طریقوں کو دائیں طرف دھکیلنے پر اصرار کرتا ہے، صاف کوڈ کو پھیلی ہوئی گندگی میں بدل دیتا ہے۔ اچانک، آپ کی ایک بار منظم لائنیں متضاد نظر آتی ہیں، اور بصری بہاؤ ٹوٹ جاتا ہے۔ مایوس کن، ہے نا؟ 🤯

مجھے یاد ہے کہ API سروس کو ری فیکٹر کرتے وقت اس مسئلے کا سامنا کرنا پڑا۔ میری بالکل منسلک طریقہ کالیں ایسی چیز میں بدل گئیں جو سیڑھیوں سے ملتی جلتی تھیں — ہر لائن کو دائیں طرف دھکیل دیا جاتا تھا۔ اس نے کوڈ کے جائزوں کو مشکل بنا دیا اور میری آنکھیں تھک گئیں۔ اس مضمون میں، میں زنجیروں والی کالوں کے لیے کلینگ فارمیٹ انڈینٹیشن پر دوبارہ کنٹرول حاصل کرنے کے لیے عملی بصیرت کا اشتراک کروں گا تاکہ آپ کا کوڈ سجیلا اور پڑھنے کے قابل رہے۔ 🛠️

# Step 1: Create a .clang-format file in your project root
# Step 2: Add the following configuration to control indentation
BasedOnStyle: Google
ContinuationIndentWidth: 4
AlignAfterOpenBracket: false
AllowShortFunctionsOnASingleLine: Empty
BreakBeforeBraces: Attach
# Align method calls relative to the previous line
ColumnLimit: 0 # Disables column wrapping
# Save and format your code

// Use clang-format directives to skip specific code regions
auto foo = FooBuilder()
    // clang-format off
    .WithSomething()
    .WithSomethingElse()
    .Build();
    // clang-format on
// clang-format will ignore indentation inside the marked section
// Useful for one-off adjustments without changing global settings
// Combine with other tools for consistency

import re
# Python script to reformat chained method calls
def adjust_indentation(input_file, output_file):
    with open(input_file, 'r') as f:
        lines = f.readlines()
    with open(output_file, 'w') as f_out:
        for line in lines:
            if re.search(r'^\s*\..*', line):
                f_out.write('    ' + line.strip() + '\n')
            else:
                f_out.write(line)
# Usage: adjust_indentation('input.cpp', 'output.cpp')

#include <gtest/gtest.h>
// Example function to validate chaining format
TEST(IndentationTest, ChainedMethods) {
    std::string expected =
        "auto foo = FooBuilder()\n"
        "    .WithSomething()\n"
        "    .WithSomethingElse()\n"
        "    .Build();";
    std::string actual = FooBuilder()
        .WithSomething()
        .WithSomethingElse()
        .Build();
    ASSERT_EQ(expected, actual);
}

عین مطابق طریقہ چیننگ کے لیے فائن ٹیوننگ کلنگ فارمیٹ

اوپر فراہم کردہ اسکرپٹس میں، ہم نے دریافت کیا کہ کس طرح ایڈجسٹ کیا جائے۔ clang-فارمیٹ C++ میں پڑھنے کے قابل اور کلین چینڈ میتھڈ کالز کو برقرار رکھنے کے لیے۔ یہ مسئلہ اس لیے پیدا ہوتا ہے کیونکہ clang-format aligns طریقہ پچھلی لائن کے بجائے پہلے فنکشن کی درخواست کے نسبت کال کرتا ہے۔ اس کو حل کرنے کے لیے، ہم نے مخصوص کمانڈز کا استعمال کیا جیسے ContinuationIndentWidth، جیسے ہدایات clang-فارمیٹ آف/آن، اور Python میں لکھی گئی پوسٹ پروسیسنگ اسکرپٹس۔ ہر طریقہ ڈیولپرز کے لیے زیادہ سے زیادہ لچک کو یقینی بنانے کے لیے استعمال کے قدرے مختلف کیس کو نشانہ بناتا ہے۔

پہلا حل جس میں ایک بنانا شامل ہے۔ .clang-format فائل یہ فائل ڈویلپرز کو اپنے C++ پروجیکٹس کے لیے فارمیٹنگ کے اصولوں کو حسب ضرورت بنانے کی اجازت دیتی ہے۔ کلیدی ترتیبات شامل ہیں۔ ContinuationIndentWidth، جو لائن کے تسلسل کے لیے خالی جگہوں کی تعداد بتاتا ہے، اور سیدھ کے بعد اوپن بریکٹ، جو clang-format کو بریکٹ کے بعد کوڈ کو غیر ضروری طور پر سیدھ میں کرنے سے روکتا ہے۔ مثال کے طور پر، ترتیب کالم کی حد: 0 لائن بریکنگ کو غیر فعال کرتا ہے، اس بات کو یقینی بناتا ہے کہ زنجیروں سے جڑے طریقے صحیح طریقے سے منسلک رہیں اور بصری طور پر دلکش رہیں۔

دوسرے نقطہ نظر میں دستی کنٹرول کا استعمال شامل تھا۔ clang-فارمیٹ آف/آن ہدایات یہ ان لائن تبصرے ہیں جو عارضی طور پر خودکار فارمیٹنگ کو غیر فعال کر دیتے ہیں۔ طریقہ کار کی زنجیروں سے پہلے اور بعد میں ان ہدایات کو حکمت عملی کے ساتھ رکھ کر، ڈویلپرز انڈینٹیشن پر مکمل کنٹرول حاصل کر لیتے ہیں۔ مثال کے طور پر، میتھڈ کالز سے پہلے "// clang-format off" داخل کرنا یقینی بناتا ہے کہ clang-format میں مداخلت نہ ہو، جب عالمی ترتیبات مثالی نہ ہوں تو یہ ایک عملی یک طرفہ حل بن جاتا ہے۔ یہ باہمی تعاون کے ماحول میں خاص طور پر مددگار ہے جہاں دوسروں کے فارمیٹنگ کے اصول مختلف ہو سکتے ہیں۔ ✨

آخر میں، ہم نے کلنگ فارمیٹ چلانے کے بعد پوسٹ پروسیس فارمیٹنگ کے مسائل کے لیے ایک ازگر اسکرپٹ متعارف کرایا۔ یہ اسکرپٹ زنجیروں والی میتھڈ کالز کے لیے اسکین کرتا ہے اور پچھلی لائن کی نسبت خالی جگہیں شامل کرکے ان کے انڈینٹیشن کو ایڈجسٹ کرتا ہے۔ ریگولر ایکسپریشنز کا استعمال کرتے ہوئے، اسکرپٹ نقطوں سے شروع ہونے والی لائنوں کی شناخت کرتا ہے (مثال کے طور پر، ".WithSomething()") اور مستقل انڈینٹیشن کا اطلاق کرتا ہے۔ اس طرح کی آٹومیشن خاص طور پر بڑے کوڈ بیسز کے لیے مفید ہے جہاں دستی مداخلت میں وقت لگتا ہے۔ مزید برآں، ہم نے گوگل ٹیسٹ میں لکھے گئے یونٹ ٹیسٹس کو شامل کیا تاکہ یہ تصدیق کی جا سکے کہ فارمیٹ شدہ کوڈ مطلوبہ انداز سے میل کھاتا ہے، متعدد ماحول میں مضبوطی کو یقینی بناتا ہے۔ 🛠️

کلینگ فارمیٹ کے ساتھ زنجیروں سے بند طریقہ انڈینٹیشن کو پرفیکٹ کرنا

استعمال کرنے کا ایک اکثر نظر انداز پہلو clang-فارمیٹ پیچیدہ کوڈ بیس میں زنجیروں والی میتھڈ کالز کے ساتھ اس کا تعامل ہے۔ جب ہم بلڈرز یا روانی سے APIs کے ساتھ کام کر رہے ہوتے ہیں، تو مناسب صف بندی پڑھنے کی اہلیت کو بڑھاتی ہے۔ ڈویلپرز چاہتے ہیں کہ طریقہ کی زنجیریں پچھلی لائن کی نسبت صاف سیدھ میں ہوں، لیکن کلینگ فارمیٹ کا ڈیفالٹ رویہ انہیں بیس میتھڈ یا فنکشن کال کے تحت سیدھ میں کرتا ہے۔ یہ بے ترتیبی، پڑھنے میں مشکل کوڈ کا باعث بن سکتا ہے جو طریقہ کی زنجیر کے منطقی بہاؤ کو توڑ دیتا ہے۔

اس سے نمٹنے کے لیے، یہ سمجھنا ضروری ہے کہ کیسے clang-فارمیٹ کوڈ پر عمل کرتا ہے۔ پہلے سے طے شدہ طور پر، یہ پیرامیٹرز پر انحصار کرتا ہے جیسے ContinuationIndentWidth اور سیدھ کے بعد اوپن بریکٹ. تاہم، یہ کنفیگریشنز ملٹی لائن کالز کو مکمل طور پر کنٹرول نہیں کرسکتی ہیں۔ مثال کے طور پر، ترتیب 0 کو 0 خودکار لائن ٹوٹنے سے روکتا ہے لیکن انڈینٹیشن کو ٹھیک نہیں کرتا ہے۔ ٹھیک کنٹرول کے لئے، ہدایات کی طرح // clang-format off اور // clang-format on کوڈ کے مخصوص علاقوں میں فارمیٹنگ کو نظرانداز کرنے کے لیے حکمت عملی کے ساتھ رکھا جا سکتا ہے۔

بعض اوقات، ایسے پروجیکٹس کے لیے جہاں ٹیموں میں مستقل فارمیٹنگ ضروری ہوتی ہے، پوسٹ پروسیسنگ اسکرپٹس یا کسٹم IDE کنفیگریشن جیسے ٹولز ضروری ہو جاتے ہیں۔ مثال کے طور پر، ایک Python اسکرپٹ جو زنجیروں والی کالوں کا پتہ لگاتا ہے اور انڈینٹیشن کو دوبارہ ترتیب دیتا ہے بیک اپ حل کے طور پر کام کر سکتا ہے۔ یہ نقطہ نظر اس بات کو یقینی بناتا ہے کہ یہاں تک کہ اگر clang-فارمیٹ نشان یاد نہیں آتا، ڈویلپر کوڈ میں تبدیلی کے بعد خود بخود مطلوبہ انداز نافذ کر سکتے ہیں۔ 🚀