Java 15 のテキストブロックを横目に C# 11 の生文字列リテラルを眺めて ECMAScript String dedent プロポーザルを想う

2022/03/02
このエントリーをはてなブックマークに追加

川辺で一句詠む看護師

さりげに複雑な複数行文字列リテラル仕様

プログラミング言語における複数行文字列リテラルの仕様は、一見した印象より決めなければならないことが多く、さりげに複雑になりがちです。

例として、 Java 15 のテキストブロックと C# 11 の生文字列リテラルを比較してみましょう(C# 11 の生文字列リテラルには単一行形式と複数行形式がありますが、ここでは複数行形式の仕様のみ扱います)。

Java テキストブロック C# 生文字列リテラル
開始・終了デリミター 開始・終了ともに """ (ダブルクォート 3 つ)
開始側は改行必須
"""""""""""" などダブルクォート 3 つ以上(開始・終了で合わせる)
開始側・終了側ともに改行必須
変数を埋め込む場合は開始デリミターに 1 つ以上のドル記号 $ をつけて $"""$$"""$$""""" のようにする
最初と最後の改行を文字列値に含めるか 最初の改行は含めない、最後の改行は含める
(最後の改行を含めたくない場合はコンテンツ末尾行で改行せずに """ で閉じる)
含めない
エスケープシーケンスの扱い エスケープする
(たとえばコード上の \n はラインフィードになる)
エスケープしない
(たとえばコード上の \n はそのまま文字 \n になる)
改行キャンセルの可否 できる(行末バックスラッシュ) できない
文字列値中の改行文字 CRLF は LF に置換 コード上の改行文字のまま
行頭の空白文字(インデント)を(どこまで)削除するか インデントの最も少ない行がインデントゼロになるように各行のインデントを削除する 終了デリミターがインデントゼロになるように各行のインデントを削除する
(終了デリミターよりインデントが少ない行があるとコンパイルエラー)
行末の空白文字を削除するか 削除する
エスケープシーケンス \s は空白文字に置換されて残るので必要ならこれを利用する
改行キャンセル時の行末バックスラッシュまでの空白文字は削除しない
削除しない
式(変数)の埋め込み可否、埋め込み構文 埋め込めない 埋め込める
式を埋め込む場合は、開始デリミターに 1 つ以上の $ をつけ、その $ と同じ数の波括弧 { } で式を括る
(たとえば開始デリミターが $$$"""" であれば、変数 x の埋め込みは {{{x}}} となり、 2 つまでの波括弧 {{}} はそのままエスケープなしで含めることができる)
複数行文字列リテラルのデリミターをエスケープなしで含められるか 含められない(要エスケープ) 含められる
たとえば """ (ダブルクォート 3 つ)を含めるにはデリミターを """" (4 つ)にする

どちらも """ で始まり """ で終わる複数行文字列リテラルの表現であり、一見するとよく似ています。が、細部を見れば全く異なることがわかると思います。プログラマーはこれら細かい仕様(差異)を意識する必要があり、そうでなければ時折「エ゙ッ!?」と声を出して驚くことになります。

※ 記事執筆時点で C# の生文字列リテラルを使うには、 Visual Studio 2022 バージョン 17.2 Preview 1 で、プロジェクトファイルに <LangVersion>preview</LangVersion> を記述する必要がありました(Mac 版 17.2 Preview は未提供でした)。

コンテンツにデリミターを含めるために

プログラミング言語 X でプログラミング言語 X のコードを生成したい、といった要求はまれによくあるものです。文字列リテラルを含むコードを文字列リテラルで表現する際、デリミターが工夫されていないとエスケープが必要になります。本来コードのコピペで済ませたいわけですが、コピペしたあとエスケープして回るハメになります。

// JavaScript
// テンプレートリテラルを含むコードをテンプレートリテラルで表現するにはエスケープが必要です。
eval(`
  const answer = 42;
  console.log(\`The answer is \${answer}.\\n\`);
`);
// エスケープシーケンスを無視するために String.raw を使うと、これまた面倒なことになります。
eval(String.raw`
  const answer = 42;
  console.log(${"`"}The answer is ${"$"}{answer}.\n${"`"});
`);
  • C# の生文字列リテラル では、上述の通り、コンテンツに 3 つの連続したダブルクォート """ を含めたいならデリミターをダブルクォート 4 つ """" にします。変数埋め込み用のデリミター { } の数も開始デリミターの $ の数で調整でき、表現力が高いです。
  • Markdown のコードブロック の開始デリミターは ```````````` など、 3 つ以上のバックティックです。終了デリミターは開始デリミターと同じかそれ以上の数のバックティックになります。コンテンツに ``` を含めたいならデリミターを ```` にします。
  • Swift の Extended String Delimiters は、 #"..."# のように、ダブルクォートの外側に 1 つ以上の # をつけることで、エスケープシーケンスを無視して(エスケープせず)生文字列を記述する機能です。 ##"..."## のように # の数を増やすことで、コンテンツに #" を含めることができます。
  • Ruby のヒアドキュメントD 言語の Delimited StringsC++ の生文字列リテラル では、デリミターに任意の識別子を含めることができます。

ECMAScript – String dedent プロポーザル

ECMAScript 2015 に導入されたテンプレートリテラルでは、行頭の空白文字(インデント)が文字列値にそのまま残ります。一方で、インデントを解除したいという要求は確実にあり、インデント解除のためのテンプレート用タグを提供するライブラリ Dedent のダウンロード数は 1 週間あたり 10,000,000 件以上に達しています。類似ライブラリもぎょーさんあります。 そして新しい構文の提案も(何年も前から)あります。

いくつか構文案が挙がっていますが、個人的に興味深いと思ったのは、デリミターに ``` を採用した場合に発生する、 ECMAScript のバージョンによって異なる挙動を持つコード例です。

x = () => x;
x
```
`
alert("am i an inert string ... or am I eval? depends on your browser, if single backticks don’t need escaping!");
x
`
```

このような問題をうまく避けつつ、他の言語仕様を参考にして、できれば C# の生文字列リテラルのように表現力の高い仕様になってほしい気持ちです(dedent (インデント解除)という名のプロポーザルにどこまで期待するのでしょう)。

2022-04-01 追記

3 月の TC39 ミーティングで String dedent 用の構文追加に反対されたようで、専用構文ではなく単なるタグ関数になりそうです。

その他の記事

Other Articles

2022/06/03
拡張子に Web アプリを関連付ける File Handling API の使い方

2022/03/22
<selectmenu> タグできる子; <select> に代わるカスタマイズ可能なドロップダウンリスト

2021/10/13
Angularによる開発をできるだけ型安全にするためのKabukuでの取り組み

2021/09/30
さようなら、Node.js

2021/09/30
Union 型を含むオブジェクト型を代入するときに遭遇しうるTypeScript型チェックの制限について

2021/09/16
[ECMAScript] Pipe operator 論争まとめ – F# か Hack か両方か

2021/07/05
TypeScript v4.3 の機能を使って immutable ライブラリの型付けを頑張る

2021/06/25
Denoでwasmを動かすだけの話

2021/05/18
DOMMatrix: 2D / 3D 変形(アフィン変換)の行列を扱う DOM API

2021/03/29
GoのWASMがライブラリではなくアプリケーションであること

2021/03/26
Pythonプロジェクトの共通のひな形を作る

2021/03/25
インラインスタイルと Tailwind CSS と Tailwind CSS 入力補助ライブラリと Tailwind CSS in JS

2021/03/23
Serverless NEGを使ってApp Engineにカスタムドメインをワイルドカードマッピング

2021/01/07
esbuild の機能が足りないならプラグインを自作すればいいじゃない

2020/08/26
TypeScriptで関数の部分型を理解しよう

2020/06/16
[Web フロントエンド] esbuild が爆速すぎて webpack / Rollup にはもう戻れない

2020/03/19
[Web フロントエンド] Elm に心折れ Mint に癒しを求める

2020/02/28
さようなら、TypeScript enum

2020/02/14
受付のLooking Glassに加えたひと工夫

2020/01/28
カブクエンジニア開発合宿に行ってきました 2020冬

2020/01/30
Renovateで依存ライブラリをリノベーションしよう 〜 Bitbucket編 〜

2019/12/27
Cloud Tasks でも deferred ライブラリが使いたい

2019/12/25
*, ::before, ::after { flex: none; }

2019/12/21
Top-level awaitとDual Package Hazard

2019/12/20
Three.jsからWebGLまで行きて帰りし物語

2019/12/18
Three.jsに入門+手を検出してAR.jsと組み合わせてみた

2019/12/04
WebXR AR Paint その2

2019/11/06
GraphQLの入門書を翻訳しました

2019/09/20
Kabuku Connect 即時見積機能のバックエンド開発

2019/08/14
Maker Faire Tokyo 2019でARゲームを出展しました

2019/07/25
夏休みだョ!WebAssembly Proposal全員集合!!

2019/07/08
鵜呑みにしないで! —— 書籍『クリーンアーキテクチャ』所感 ≪null 篇≫

2019/07/03
W3C Workshop on Web Games参加レポート

2019/06/28
TypeScriptでObject.assign()に正しい型をつける

2019/06/25
カブクエンジニア開発合宿に行ってきました 2019夏

2019/06/21
Hola! KubeCon Europe 2019の参加レポート

2019/06/19
Clean Resume きれいな環境できれいな履歴書を作成する

2019/05/20
[Web フロントエンド] 状態更新ロジックをフレームワークから独立させる

2019/04/16
C++のenable_shared_from_thisを使う

2019/04/12
OpenAPI 3 ファーストな Web アプリケーション開発(Python で API 編)

2019/04/08
WebGLでレイマーチングを使ったCSGを実現する

2019/03/29
その1 Jetson TX2でk3s(枯山水)を動かしてみた

2019/04/02
『エンジニア採用最前線』に感化されて2週間でエンジニア主導の求人票更新フローを構築した話

2019/03/27
任意のブラウザ上でJestで書いたテストを実行する

2019/02/08
TypeScript で “radian” と “degree” を間違えないようにする

2019/02/05
Python3でGoogle Cloud ML Engineをローカルで動作する方法

2019/01/18
SIGGRAPH Asia 2018 参加レポート

2019/01/08
お正月だョ!ECMAScript Proposal全員集合!!

2019/01/08
カブクエンジニア開発合宿に行ってきました 2018秋

2018/12/25
OpenAPI 3 ファーストな Web アプリケーション開発(環境編)

2018/12/23
いまMLKitカスタムモデル(TF Lite)は使えるのか

2018/12/21
[IoT] Docker on JetsonでMQTTを使ってCloud IoT Coreと通信する

2018/12/11
TypeScriptで実現する型安全な多言語対応(Angularを例に)

2018/12/05
GASでCompute Engineの時間に応じた自動停止/起動ツールを作成する 〜GASで簡単に好きなGoogle APIを叩く方法〜

2018/12/02
single quotes な Black を vendoring して packaging

2018/11/14
3次元データに2次元データの深層学習の技術(Inception V3, ResNet)を適用

2018/11/04
Node Knockout 2018 に参戦しました

2018/10/24
SIGGRAPH 2018参加レポート-後編(VR/AR)

2018/10/11
Angular 4アプリケーションをAngular 6に移行する

2018/10/05
SIGGRAPH 2018参加レポート-特別編(VR@50)

2018/10/03
Three.jsでVRしたい

2018/10/02
SIGGRAPH 2018参加レポート-前編

2018/09/27
ズーム可能なSVGを実装する方法の解説

2018/09/25
Kerasを用いた複数入力モデル精度向上のためのTips

2018/09/21
競技プログラミングの勉強会を開催している話

2018/09/19
Ladder Netwoksによる半教師あり学習

2018/08/10
「Maker Faire Tokyo 2018」に出展しました

2018/08/02
Kerasを用いた複数時系列データを1つの深層学習モデルで学習させる方法

2018/07/26
Apollo GraphQLでWebサービスを開発してわかったこと

2018/07/19
【深層学習】時系列データに対する1次元畳み込み層の出力を可視化

2018/07/11
きたない requirements.txt から Pipenv への移行

2018/06/26
CSS Houdiniを味見する

2018/06/25
不確実性を考慮した時系列データ予測

2018/06/20
Google Colaboratory を自分のマシンで走らせる

2018/06/18
Go言語でWebAssembly

2018/06/15
カブクエンジニア開発合宿に行ってきました 2018春

2018/06/08
2018 年の tree shaking

2018/06/07
隠れマルコフモデル 入門

2018/05/30
DASKによる探索的データ分析(EDA)

2018/05/10
TensorFlowをソースからビルドする方法とその効果

2018/04/23
EGLとOpenGLを使用するコードのビルド方法〜libGLからlibOpenGLへ

2018/04/23
技術書典4にサークル参加してきました

2018/04/13
Python で Cura をバッチ実行するためには

2018/04/04
ARCoreで3Dプリント風エフェクトを実現する〜呪文による積層造形映像制作の舞台裏〜

2018/04/02
深層学習を用いた時系列データにおける異常検知

2018/04/01
音声ユーザーインターフェースを用いた新方式積層造形装置の提案

2018/03/31
Container builderでコンテナイメージをBuildしてSlackで結果を受け取る開発スタイルが捗る

2018/03/23
ngUpgrade を使って AngularJS から Angular に移行

2018/03/14
Three.jsのパフォーマンスTips

2018/02/14
C++17の新機能を試す〜その1「3次元版hypot」

2018/01/17
時系列データにおける異常検知

2018/01/11
異常検知の基礎

2018/01/09
three.ar.jsを使ったスマホAR入門

2017/12/17
Python OpenAPIライブラリ bravado-core の発展的な使い方

2017/12/15
WebAssembly(wat)を手書きする

2017/12/14
AngularJS を Angular に移行: ng-annotate 相当の機能を TypeScrpt ファイルに適用

2017/12/08
Android Thingsで4足ロボットを作る ~ Android ThingsとPCA9685でサーボ制御)

2017/12/06
Raspberry PIとDialogflow & Google Cloud Platformを利用した、3Dプリンターボット(仮)の開発 (概要編)

2017/11/20
カブクエンジニア開発合宿に行ってきました 2017秋

2017/10/19
Android Thingsを使って3Dプリント戦車を作ろう ① ハードウェア準備編

2017/10/13
第2回 魁!! GPUクラスタ on GKE ~PodからGPUを使う編~

2017/10/05
第1回 魁!! GPUクラスタ on GKE ~GPUクラスタ構築編~

2017/09/13
「Maker Faire Tokyo 2017」に出展しました。

2017/09/11
PyConJP2017に参加しました

2017/09/08
bravado-coreによるOpenAPIを利用したPythonアプリケーション開発

2017/08/23
OpenAPIのご紹介

2017/08/18
EuroPython2017で2名登壇しました。

2017/07/26
3DプリンターでLチカ

2017/07/03
Three.js r86で何が変わったのか

2017/06/21
3次元データへの深層学習の適用

2017/06/01
カブクエンジニア開発合宿に行ってきました 2017春

2017/05/08
Three.js r85で何が変わったのか

2017/04/10
GCPのGPUインスタンスでレンダリングを高速化

2017/02/07
Three.js r84で何が変わったのか

2017/01/27
Google App EngineのFlexible EnvironmentにTmpfsを導入する

2016/12/21
Three.js r83で何が変わったのか

2016/12/02
Three.jsでのクリッピング平面の利用

2016/11/08
Three.js r82で何が変わったのか

2016/12/17
SIGGRAPH 2016 レポート

2016/11/02
カブクエンジニア開発合宿に行ってきました 2016秋

2016/10/28
PyConJP2016 行きました

2016/10/17
EuroPython2016で登壇しました

2016/10/13
Angular 2.0.0ファイナルへのアップグレード

2016/10/04
Three.js r81で何が変わったのか

2016/09/14
カブクのエンジニアインターンシッププログラムについての詩

2016/09/05
カブクのエンジニアインターンとして3ヶ月でやった事 〜高橋知成の場合〜

2016/08/30
Three.js r80で何が変わったのか

2016/07/15
Three.js r79で何が変わったのか

2016/06/02
Vulkanを試してみた

2016/05/20
MakerGoの作り方

2016/05/08
TensorFlow on DockerでGPUを使えるようにする方法

2016/04/27
Blenderの3DデータをMinecraftに送りこむ

2016/04/20
Tensorflowを使ったDeep LearningにおけるGPU性能調査

→
←

関連職種

Recruit

バックエンドエンジニア(TypeScript)

業務内容

業務内容 当ポジションは自社開発のWebサービスのバックエンドシステムの設計及び実装の担当をお願いします。 2週間を1スプリントとしたスクラム開発を実施しています。 週次で開発チームミーティングを実施し、設計の相談や工数 […]

フロントエンドエンジニア(TypeScript)

業務内容

業務内容 当ポジションは弊社Webサービスのフロントエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工 […]

→
←

お客様のご要望に「Kabuku」はお応えいたします。
ぜひお気軽にご相談ください。

お電話でも受け付けております
03-6380-2750
営業時間:09:30~18:00
※土日祝は除く