Prog/formatter/clang-format

目次†

書式オプション（抜粋）†

• clang-format で使用される書式設定ファイル .clang-format に記述するオプションについて記載する。

Language:†

AccessModifierOffset:†

• アクセス修飾子（C++ class の public:, private:, protected: など）の追加のインデント幅を指定する。
• パラメータと挙動
  • 0

    class CFoo : public CSuperFoo
    {
        public:
        CFoo(int ini_a, char* ini_b) : m_a(ini_a), m_b(ini_b), m_c{} {}
    
        private:
        char*    m_b;
        uint64_t m_c;
    };

  • -2

    class CFoo : public CSuperFoo
    {
      public:
        CFoo(int ini_a, char* ini_b) : m_a(ini_a), m_b(ini_b), m_c{} {}
    
      private:
        int      m_a;
        char*    m_b;
        uint64_t m_c;
    };

  • -4

    class CFoo : public CSuperFoo
    {
    public:
        CFoo(int ini_a, char* ini_b) : m_a(ini_a), m_b(ini_b), m_c{} {}
    
    private:
        int      m_a;
        char*    m_b;
        uint64_t m_c;
    };

AlignAfterOpenBracket:†

• 括弧 (()、<>、[]) 内のパラメータが1行に収まらない場合の開始括弧の直後の整列方法を指定する。下記の例では、1行を80カラムとしている（ColumnLimit:80）
• パラメータと挙動
  • Align

    // 仮引数は、カラム上限にかかった場合に改行される。仮引数の整列はアリ
    void func_c(std::string& hoge_name, std::vector<std::string>& name_list,
                std::vector<uint64_t> param_list)
    {
        uint32_t local_count(0);
        for (std::vector<std::string>::iterator it_of_name_list = name_list.begin();
             it_of_name_list != name_list.end();
             ++it_of_name_list) {
            uint32_t ret =
                sub_func(hoge_name, *it_of_name_list, param_list, local_count);
            ++local_count;
        }
        // カラム上限に達していなければ改行されない
        for (uint32_t i = 1; i < max_count; ++i) {
            sub_func_2(hoge_name, name_list, param_list);
        }
    }

• DontAlign

  // 仮引数は、カラム上限にかかった場合に改行される。仮引数の整列はナシ
  void func_c(std::string& hoge_name, std::vector<std::string>& name_list,
      std::vector<uint64_t> param_list)
  {
      uint32_t local_count(0);
      for (std::vector<std::string>::iterator it_of_name_list = name_list.begin();
           it_of_name_list != name_list.end();
           ++it_of_name_list) {
          uint32_t ret =
              sub_func(hoge_name, *it_of_name_list, param_list, local_count);
          ++local_count;
      }
      // カラム上限に達していなければ改行されない
      for (uint32_t i = 1; i < max_count; ++i) {
          sub_func_2(hoge_name, name_list, param_list);
      }
  }

• AlwaysBreak

  // 仮引数は、先頭と、カラム上限にかかった場合に改行される。結果的に整列されたに等しくなる。
  void func_c(
      std::string& hoge_name, std::vector<std::string>& name_list,
      std::vector<uint64_t> param_list)
  {
      uint32_t local_count(0);
      for (std::vector<std::string>::iterator it_of_name_list = name_list.begin();
           it_of_name_list != name_list.end();
           ++it_of_name_list) {
          uint32_t ret =
              sub_func(hoge_name, *it_of_name_list, param_list, local_count);
          ++local_count;
      }
      // カラム上限に達していなければ改行されない
      for (uint32_t i = 1; i < max_count; ++i) {
          sub_func_2(hoge_name, name_list, param_list);
      }
  }

AlignConsecutiveAssignments:†

• 連続する行の代入式を = で整列するか否か
• パラメータと挙動
  • true : 整列する

       int32_t var_1           = 12;
       std::string var_2       = "foo";
       const char* const var_3 = "bar";

• false : 整列しない

     int32_t var_1 = 12;
     std::string var_2 = "foo";
     const char* const var_3 = "bar";

AlignConsecutiveDeclarations:†

• 連続する行の宣言の変数名を整列させるか否か
• パラメータと挙動
  • true : 整列する

       int32_t           var_11 = 12;
       std::string       var_2 = "foo";
       const char* const var_3 = "bar";

• false : 整列しない

     int32_t var_11 = 12;
     std::string var_2 = "foo";
     const char* const var_3 = "bar";

AlignEscapedNewlinesLeft:†

• エスケープされた改行の位置を調整する
• パラメータと挙動
  • true : 可能な限り左に寄せる

    #define LOG_PREFIX \
        "[DEBUG]"      \
        "[MODULE_A]"   \
        "[MOD_SUB_2]"

• false : column limit に配置する

  // ColumnLimit: 80 の場合
  #define LOG_PREFIX                                                             \
      "[DEBUG]"                                                                  \
      "[MODULE_A]"                                                               \
      "[MOD_SUB_2]"

AlignOperands:†

AlignTrailingComments:†

AllowAllParametersOfDeclarationOnNextLine:†

AllowShortBlocksOnASingleLine:†

• 短いブレース文を単一の行に押し込むか否か
• パラメータと挙動
• true : 単一行に押し込む

      if (arg > 10) { var_11 += arg; }

• false : 単一行に押し込まない

      if (arg > 10) {
          var_11 += arg;
      }

• 但し、以下のような構造体初期化文には効力がない模様

      st_aaa aaa = {
          0,
      };

AllowShortCaseLabelsOnASingleLine:†

• switch-case 文に於いて、短い case 文を1行で書くことを許容するか否かを指定する。
• true 短い case 文を1行にする

      switch (tcx_type) {
      case TCX_TYPE1: break;
      case TCX_TYPE2: break;
      case TCX_TYPE2_NORMAL_STYLE: break;
      case TCX_TYPE3: break;
      case TCX_TYPE3_______________________________LONG: break;
      default:
          break;
      }

• false 短い case 文を1行にしない。

       switch (tcx_type) {
       case TCX_TYPE1:
          break;
      case TCX_TYPE2:
          break;
      case TCX_TYPE2_NORMAL_STYLE:
          break;
      case TCX_TYPE3:
          break;
      case TCX_TYPE3_______________________________LONG:
          break;
      default:
          break;
      }

AllowShortFunctionsOnASingleLine:†

AllowShortIfStatementsOnASingleLine:†

AllowShortLoopsOnASingleLine:†

AlwaysBreakAfterDefinitionReturnType:†

AlwaysBreakAfterReturnType:†

AlwaysBreakBeforeMultilineStrings:†

AlwaysBreakTemplateDeclarations:†

BinPackArguments:†

BinPackParameters:†

BraceWrapping:†

AfterClass:†

AfterControlStatement:†

AfterEnum:†

AfterFunction:†

AfterNamespace:†

AfterObjCDeclaration:†

AfterStruct:†

AfterUnion:†

BeforeCatch:†

BeforeElse:†

IndentBraces:†

BreakBeforeBinaryOperators:†

BreakBeforeBraces:†

• 波括弧 { } の改行の設定
• パラメータと挙動
  • Attach

    // 波括弧は常に周囲のコンテキストにくっつける。
    enum HOGE_EN {
        EN_AAA,
        EN_ABC,
        EN_ZZZ,
    };
    
    struct st_aaa {
        int aaa[2];
        uint64_t ax;
    };
    
    void func(int arg) {
        // ...
        if (arg == 0) {
            // ...
        } else {
            // ...
        }
        return;
    }

• Linux

  // Attach に似るが、関数や名前空間、クラス定義の前は改行する。
  enum HOGE_EN {
      EN_AAA,
      EN_ABC,
      EN_ZZZ,
  };
  
  struct st_aaa {
      int aaa[2];
      uint64_t ax;
  };
  
  void func(int arg)
  {
      // ...
      if (arg == 0) {
          // ...
      } else {
          // ...
      }
      return;
  }

• Mozilla

  // Attach と似るが、 enum、関数定義などの前には改行する。
  enum HOGE_EN
  {
      EN_AAA,
      EN_ABC,
      EN_ZZZ,
  };
  
  struct st_aaa
  {
      int aaa[2];
      uint64_t ax;
  };
  
  void func(int arg)
  {
      // ...
      if (arg == 0) {
          // ...
      } else {
          // ...
      }
      return;
  }

• Stroustrup

  // Attach と似るが、catch, else などの前は改行する。
  enum HOGE_EN {
      EN_AAA,
      EN_ABC,
      EN_ZZZ,
  };
  
  struct st_aaa {
      int aaa[2];
      uint64_t ax;
  };
  
  void func(int arg)
  {
      // ...
      if (arg == 0) {
          // ...
      }
      else {
          // ...
      }
      return;
  }

• Allman

  // 波括弧の前は全て改行する。
  enum HOGE_EN
  {
      EN_AAA,
      EN_ABC,
      EN_ZZZ,
  };
  
  struct st_aaa
  {
      int aaa[2];
      uint64_t ax;
  };
  
  void func(int arg)
  {
      // ...
      if (arg == 0)
      {
          // ...
      }
      else
      {
          // ...
      }
      return;
  }

• GNU

  // 波括弧の前は全て改行するし、新たにインデントを加える。但し、クラス定義や関数定義などの場合は除く。
  enum HOGE_EN
  {
      EN_AAA,
      EN_ABC,
      EN_ZZZ,
  };
  
  struct st_aaa
  {
      int aaa[2];
      uint64_t ax;
  };
  
  void func(int arg)
  {
      // ...
      if (arg == 0)
          {
              // ...
          }
      else
          {
              // ...
          }
      return;
  }

BreakBeforeTernaryOperators:†

BreakConstructorInitializersBeforeComma:†

• コンストラクタの変数初期化のコンマの前で改行し、コンマとコロンを整列させるかどうか
• パラメータと挙動
  • true

• false

ColumnLimit:†

• 行の長さの上限値。
• 0 に設定した場合は、上限なしとなる。

CommentPragmas:†

ConstructorInitializerAllOnOneLineOrOnePerLine:†

ConstructorInitializerIndentWidth:†

ContinuationIndentWidth:†

Cpp11BracedListStyle:†

DerivePointerAlignment:†

DisableFormat:†

ExperimentalAutoDetectBinPacking:†

ForEachMacros:†

IncludeCategories:†

-†

Priority:†

-†

Priority:†

-†

Priority:†

IndentCaseLabels:†

IndentWidth:†

IndentWrappedFunctionNames:†

KeepEmptyLinesAtTheStartOfBlocks:†

MacroBlockBegin:†

MacroBlockEnd:†

MaxEmptyLinesToKeep:†

NamespaceIndentation:†

ObjCBlockIndentWidth:†

ObjCSpaceAfterProperty:†

ObjCSpaceBeforeProtocolList:†

PenaltyBreakBeforeFirstCallParameter:†

PenaltyBreakComment:†

PenaltyBreakFirstLessLess:†

PenaltyBreakString:†

PenaltyExcessCharacter:†

PenaltyReturnTypeOnItsOwnLine:†

PointerAlignment:†

ReflowComments:†

SortIncludes:†

SpaceAfterCStyleCast:†

SpaceBeforeAssignmentOperators:†

SpaceBeforeParens:†

SpaceInEmptyParentheses:†

SpacesBeforeTrailingComments:†

SpacesInAngles:†

SpacesInContainerLiterals:†

SpacesInCStyleCastParentheses:†

SpacesInParentheses:†

SpacesInSquareBrackets:†

Standard:†

TabWidth:†

UseTab:†

参考リンク†

• ClangFormat — Algo13 2016.12.17 ドキュメント
• clang-format を イイ感じに設定する - def yasuharu519(self):

Menu

• System
• Security
• Device
• Debian
• Ubuntu
• Plan9
• CentOS
• Net
• X
• App
• transcription
• Prog
• Lang
• TeX
• Editor
  • emacs
• Multimedia
• tools
• VersionCtl
• linux:archive

Menu2

• Mac
• Windows
• 食
• 旅
• otherlinks
• SandBox

  最新の20件

  2024-05-08

  • Editor/emacs

  2024-05-06

  • 旅/茨城

  2024-05-02

  • 食
  • 旅
  • 旅/東京
  • Lang/Python/pip

  2024-04-21

  • Lang/shell/bash

  2024-04-14

  • VersionCtl/git
  • VersionCtl/git/Subversion からの移行
  • VersionCtl/git/subversion とのコマンド対比

  2024-03-31

  • Security/ssh

  2024-03-17

  • Net/dig

  2024-03-15

  • Lang/Python/開発環境

  2024-03-02

  • Net/pukiwiki

  2024-02-25

  • 食/料理

  2024-02-23

  • transcription
  • App/Browser

  2024-02-11

  • App/screen

  2024-02-10

  • Lang/shell/bash/設定

  2024-01-22

  • VersionCtl/git/tig

edit