プリティプリント

プリティプリント(またはプリティプリント) とは、ソース コード、マークアップ、および類似のコンテンツなどのテキスト ファイルにさまざまなスタイルの書式設定規則を適用することです。これらの書式設定規則には、インデント スタイルに準拠すること、ソース コードの構文要素を強調表示するために異なる色や書体を使用すること、またはサイズを調整することなどがあり、これによってユーザーがコンテンツを読みやすく理解しやすくなります。ソース コードのプリティ プリンターは、コード フォーマッタまたはビューティファイアと呼ばれることもあります。

プリティプリントとは、通常、数式を専門的にタイプセットされるのと同じような方法で表示することを指します。たとえば、MaximaやMathematicaなどのコンピュータ代数システムでは、システムは次のように出力します。x ^ 2 + 3 * x「」は「${\displaystyle x^{2}+3x}$ 」として扱われます。カシオ9860シリーズ、HP-49/50シリーズ、HP Prime、TI-84 Plus、TI-89、TI-Nspire、PrettyPt ^[1] アドオンを搭載したTI-83 Plus、同じアドオンを搭載したTI-84 Plus 、または「MathPrint」対応OSなどの一部のグラフ電卓では、プリティプリントを実行できます。さらに、カシオFX-ESシリーズ（ナチュラルディスプレイ）、シャープEL-Wシリーズ（WriteView）、HP SmartCalc 300s、 TI-30XB、Numworksなどの新しい科学電卓には、プリティプリントが可能なドットマトリックス画面が搭載されています。

多くのテキスト書式設定プログラムは数学の組版も行うことができます。TeXは高品質の数学の組版用に特別に開発されました。

マークアップ言語インスタンスでの整形印刷は、通常、階層とネストを視覚的に判断するためのタグと文字列コンテンツのインデントに関連付けられます。タグベースの言語の構文構造は大きく変わりませんが、マークアップ言語の解釈方法や記述するデータによってインデントが大きく変わる場合があります。

MathMLでは、空白文字は、XML構文で要求される以上のデータ、意味、または構文を反映しません。 HTMLでは、タグ間の空白文字はテキストとみなされ、解析結果のテキストノードとして解析されます。^[2] MathML 文書には寛大にインデントを適用できますが、HTML 文書を整形する際には、コンテンツまたはコンテンツを反映するタグ要素の概ね近い場所で追加のテキストノードが作成または破棄されないように十分な注意を払う必要があります。 この複雑さの違いは、より単純な MathML の例のように、特別なルールやエッジケースが必要ない自動化された整形操作の観点からは些細なことではありません。 HTML の例では、統一されたスタイルに準拠し、さまざまなインスタンスにわたって一貫して適用されるタグ要素とコンテンツのさまざまなパターンを考慮するために、一連の漸進的な相互関連アルゴリズムが必要になる場合があります。これは、Pretty Diffツールで HTML、XML、および関連テクノロジを整形するために使用されるmarkup.ts ^[3]アプリケーションコンポーネントによって証明されています。

プログラマーは、プログラミング言語の ソース コードを特定の方法でフォーマットするためにツールを使用することがよくあります。コードが適切にフォーマットされると、読みやすく理解しやすくなります。コードのインデントや空白の使用、中括弧の配置など、プログラマーによってフォーマットのスタイルが異なる場合があります。コード フォーマッタまたはコード インデンタは、ソース コードをあるフォーマット スタイルから別のフォーマット スタイルに変換します。プログラミング言語の構文は明確であるため、これは比較的簡単です。コードの整形には、ソース コードを代入文、ifブロック、ループなどのコンポーネント構造に解析し (制御フローも参照)、構成ファイルでユーザーが指定した方法でフォーマットすることが含まれます。

コード美化ツールはスタンドアロンアプリケーションとして存在し、テキストエディタや統合開発環境に組み込まれています。たとえば、Emacsのさまざまな言語モードでは、コードブロックを正しく美しくインデントできます。 ^[4]

プリティプリントの初期の例としては、ビル・ゴスパーの「GRINDEF」（つまり「grind function」）プログラム（ 1967年頃）がある。これは組み合わせ検索と刈り込みを使用してLISPプログラムをフォーマットする。初期のバージョンはLispプログラムの実行可能形式（リスト構造）で動作し、さまざまな関数の特別な意味は考慮されなかった。後のバージョンでは、実行不可能なコメントを組み込むための特別な読み取り規則と、展開されていない形式で読み取りマクロを保持するための特別な読み取り規則が採用された。また、などの特別な関数に対して特別なインデント規則も許可されたif。^{[5] [6]}「grind」という用語は、一部のLisp界隈ではプリティプリントの同義語として使用された。^[7]

多くのオープンソースプロジェクトでは、コードレイアウトのルールが確立されています。最も典型的なのは、GNUフォーマット^[8]とBSDスタイル^[9]です。この2つの最大の違いは中括弧の位置です。GNUスタイルでは、開き中括弧と閉じ中括弧は、同じインデントで、それぞれ別の行にあります。BSDスタイルでは、開き中括弧は前の行の末尾に配置され、閉じ中括弧の後にelseが続きます。インデントのサイズと空白の位置も異なります。

次の例は、いくつかの典型的な C 構造と、さまざまなインデント スタイルルールがそれらをどのようにフォーマットするかを示しています。フォーマットをまったく行わない場合は、次のようになります。

int foo ( int k ){ if ( k < 1 || k > 2 ){ printf ( "範囲外\n " ); printf ( "この関数は 1 または 2 の値を必要とします\n " );} else { printf ( "切り替え\n " ); switch ( k ){ case 1 : printf ( "1 \n " ); break ; case 2 : printf ( "2 \n " ); break ;}}}  

 

GNUインデント プログラムは、GNU ルールに従ってインデントするように要求されると、次の出力を生成します。

int 
foo ( int k ) { if ( k < 1 || k > 2 ) { printf ( "範囲外\n " ); printf ( "この関数は 1 または 2 の値を必要とします\n " ); } else { printf ( "切り替え\n " ); switch ( k ) { case 1 : printf ( "1 \n " ); break ; case 2 : printf ( "2 \n " ); break ; } } }  

         
    
       
       
    
  
    
       
       
        
         
           
          
         
           
          
        
    

BSD ルールに従ってフォーマットすると、次の出力が生成されます。

int 
foo ( int k ) { if ( k < 1 || k > 2 ) { printf ( "範囲外\n " ); printf ( "この関数は 1 または 2 の値を必要とします\n " ); } else { printf ( "切り替え\n " ); switch ( k ) { case 1 : printf ( "1 \n " ); break ; case 2 : printf ( "2 \n " ); break ; } } }  
	        
		
		
	  
		
		  
		 
			
			
		 
			
			
		
	

関連概念

• 弾性タブストップ、多くのソースコードエディタの機能で、整列したインデントを検出して維持する
• 縮小化、つまりソースコードをコンパクトにするが、人間が理解しにくくなる
• 難読化とは、ソースコードを意図的に人間にとって理解しにくくすることであり、特に複雑になるにつれて、

ユーティリティ

• enscript は、きれいな印刷機能を備えたテキストから PostScript へのコンバータです。

• アルゴリズム 268: ALGOL 60 リファレンス言語編集者William M. McKeeman : Commun. ACM 8(11): 667-668 (1965)
• lgrind、包括的な TEX アーカイブ ネットワーク
• NEATER2: PL/I ソースステートメントリフォーマッターKenneth Conrow、Ronald G. Smith : Commun. ACM 13(11): 669-675 (1970)
• SOAP - わかりにくい Algol プログラムを簡素化RS Scowen、D. Allin、AL Hillman、M. Shimell : National Physical Laboratory Central Computer Unit レポート CCU6 (1969 年 4 月) SOAP ソース コードのフォーマットされたリストが含まれています。
  • SOAP - ALGOL 60 プログラムを文書化および編集するプログラム。RS Scowen、D. Allin、AL Hillman、M. Shimell : Comput. J. 14(2): 133-135 (1971)
  • KDF9 からのオリジナルの SOAP ソース コード
• SOAP ユーザーズ ガイド (エディンバラ IMP向け) Peter Salkeld Robertson (1976)
  • IMP9の SOAP ソース コード
• Soap80: IMP80 ソース プログラムをフォーマットするプログラム。JM Murison、エディンバラ地域コンピュータ センター(1980)
  • IMP80 の SOAP ソース コードE. N. Gregory、ケント大学カンタベリー校、Peter D. Stephens、エディンバラ地域コンピュータ センター
• PRETTYP.PAS 初期の Pascal プリティプリンタ。Ledgard他
• パスカルのスタイル (1979)
• style(9) FreeBSDスタイルガイドライン
• vgrind、[Unix] 伝統プロジェクト
• ソースコードのフォーマット GNU スタイルガイドライン