FreeBASIC ProPgMacros

プリプロセッサは、文字列置換メカニズムの中に、置換される識別子に、提供されたパラメータを使えます。
これらのパラメーターは、置換文字列で、変更せずに置換されます。
置換文字列は、マクロと呼ばれます。

マクロを定義する構文は次のとおりです（'Preprocessor commands' を参照）:
# stringize 演算子を、マクロ・パラメーターで使って、マクロ・パラメーターを文字列リテラルに変換できます。また、## concatenate 演算子を使って、トークンをマージできます。
（'Preprocessor Operators' を参照）

定義とマクロは、 scope されます（これらは、定義されたスコープでのみ、表示されます）。
一方、名前空間は、定義とマクロの可視性に、影響を与えません。

マクロのメカニズムにより、すべての型で機能する、一般的な手続きと同等のことができます。
ただし、マクロに渡されるパラメーターは、マクロ定義で使用されるたびに、マクロによって評価されることに、注意する必要があります。
これにより、パフォーマンスの問題が発生したり、さらに悪いことに、望ましくないエッジ効果(境界部分が外部からの影響を受けること)が発生する可能性があります。

括弧は、常にマクロのパラメーターを囲む必要があります:
同様に、値を返すマクロは、別の式で使う前に、完全な評価を強制するために、括弧で囲む必要があります。

正しくないマクロと、正しいマクロの例：

マクロを使うことは、極めて安全ではなく、見つけるのが非常に難しい、多くの落とし穴を隠します。
手続きは、型チェックとスコープを提供しますが、マクロは、渡された引数を、置き換えるだけです。
マクロのもう 1つの欠点は、プログラムのサイズです。
その理由は、プリ-プロセッサは、プログラムのコンパイル・プロセスの前に、プログラム内のすべてのマクロを、実際の定義に、置き換えるからです。

ソース・コード・ファイルだけを見て、問題の原因を見つける唯一の方法は、マクロの定義を見て、何が起こったかを理解することです。
マクロを使う場合の最も一般的なエラーは、不均衡な開き括弧です（コンパイル時に、エラーが発生します）。
もう1つは、マクロ定義で、引数（または、存在する場合は戻り値）を括弧で囲むことを忘れることです。
これは、演算子の優先順位のために、かなり厄介な副作用を引き起こす可能性があります（コンパイル時のエラーや実行時のバグを引き起こします）。

コンパイラーは（展開後に）マクロ内でエラーを検出すると、素朴なエラー・メッセージを提示します。含まれるのは次のものだけです:
エラーが明らかでない場合（不鮮明な報告エラーの場合）、唯一の解決策（コール行番号のみ）は、現在、修正が成功するまで、次の 5つのステップを繰り返し実行することです：
短いコードのエラーの例:

• Source file (*.bas):
  #macro FIRST(array, Operator)
    For index As Integer = LBound(array) To UBound(array) - 1
      Print " " Operator array(index) Operator ",";
    Next index
    Print array(UBound(array))
  #endmacro
  
  #macro Second(array)
    Print #array + ":"
    FIRST(array, +)
  #endmacro
  
  Dim As String test1(0 To ... ) => {"First", "Second", "Third"}
  Dim As Integer test2(0 To ...) => {1, 2 ,3}
  
  Second(test1)
  Print
  Second(test2)
  
  Sleep

  
  Compiler output:
  

  ...\FBIDETEMP.bas(18) error 20: Type mismatch, found '+' in 'SECOND(test2)'
  
  
• Pre-processed file (*.pp.bas):
  Dim As String test1(0 To ... ) => {"First", "Second", "Third"}
  Dim As Integer test2(0 To ...) => {1, 2 ,3}
  
   Print $"test1" + ":"
   For index As Integer =LBound(test1) To UBound(test1) -1
   Print " " + test1(index) + ",";
   Next index
   Print test1(UBound(test1))
  Print
   Print $"test2" + ":"
   For index As Integer =LBound(test2) To UBound(test2) -1
   Print " " + test2(index) + ",";
   Next index
   Print test2(UBound(test2))
  
  Sleep

  
  Compiler output:
  

  ...\FBIDETEMP.bas(14) error 20: Type mismatch, found '+' in 'Print " " + test2(index) + ",";'
  
  
• Example macro correction in source code (*.bas):
  #macro FIRST(array, Operator)
    For index As Integer = LBound(array) To UBound(array) - 1
      Print " " Operator array(index) Operator ",";
    Next index
    Print array(UBound(array))
  #endmacro
  
  #macro Second(array)
    Print #array + ":"
    FIRST(array, &)     ''corrected line ("&" instead of "+")
  #endmacro
  
  Dim As String test1(0 To ... ) => {"First", "Second", "Third"}
  Dim As Integer test2(0 To ...) => {1, 2 ,3}
  
  Second(test1)
  Print
  Second(test2)
  
  Sleep

  
  出力:
  

  test1:
   First, Second,Third
  
  test2:
   1, 2, 3

  
  

#macro か #define 宣言の最後のパラメータの後ろに省略記号 "..." （3つの点）を使うと、可変長のマクロを作成できます：
そのため、variadic_parameter を通じて任意の数の引数を渡すことができ、それらは通常のマクロ・パラメータであるかのように本体で使うことができます。
マクロ展開時には、マクロの置換リストにある variadic_parameter の各出現箇所が、渡された引数で置き換えられます。
variadic_parameter は、カンマを含む渡された引数の完全なリストに展開され、完全に空にすることもできます。

可変引数リスト内の個々の引数に、再帰的にアクセスするための直接的な手段は提供されていません。
variadic_parameter によって渡されるさまざまな引数を区別するには、最初に # stringize 演算子を使って variadic_parameter を文字列リテラルに変換し、次にこの文字列リテラル (#variadic_parameter) で渡された各引数を区切り文字 (コンマ) で区別します。

1行と、複数行のマクロの例：

可変長のマクロを使った例：