X-Macrosについて知りました。Xマクロの実際の使用法はどのようなものですか。彼らはいつ仕事に適したツールですか？
27815 次
7 に答える
106
数年前、コードで関数ポインターを使い始めたときに X マクロを発見しました。私は組み込みプログラマであり、ステート マシンを頻繁に使用します。多くの場合、次のようなコードを書きます。
/* declare an enumeration of state codes */
enum{ STATE0, STATE1, STATE2, ... , STATEX, NUM_STATES};
/* declare a table of function pointers */
p_func_t jumptable[NUM_STATES] = {func0, func1, func2, ... , funcX};
問題は、状態の列挙の順序と一致するように関数ポインタ テーブルの順序を維持する必要があると非常にエラーが発生しやすいと考えたことです。
友人が X マクロを紹介してくれましたが、頭の中で電球が切れたようでした。真剣に、あなたは私の人生のx-マクロでどこにいましたか！
そこで、次の表を定義します。
#define STATE_TABLE \
ENTRY(STATE0, func0) \
ENTRY(STATE1, func1) \
ENTRY(STATE2, func2) \
...
ENTRY(STATEX, funcX) \
そして、次のように使用できます。
enum
{
#define ENTRY(a,b) a,
STATE_TABLE
#undef ENTRY
NUM_STATES
};
と
p_func_t jumptable[NUM_STATES] =
{
#define ENTRY(a,b) b,
STATE_TABLE
#undef ENTRY
};
おまけとして、次のようにプリプロセッサに関数プロトタイプを作成させることもできます。
#define ENTRY(a,b) static void b(void);
STATE_TABLE
#undef ENTRY
別の使用法は、レジスタを宣言して初期化することです
#define IO_ADDRESS_OFFSET (0x8000)
#define REGISTER_TABLE\
ENTRY(reg0, IO_ADDRESS_OFFSET + 0, 0x11)\
ENTRY(reg1, IO_ADDRESS_OFFSET + 1, 0x55)\
ENTRY(reg2, IO_ADDRESS_OFFSET + 2, 0x1b)\
...
ENTRY(regX, IO_ADDRESS_OFFSET + X, 0x33)\
/* declare the registers (where _at_ is a compiler specific directive) */
#define ENTRY(a, b, c) volatile uint8_t a _at_ b:
REGISTER_TABLE
#undef ENTRY
/* initialize registers */
#define ENTRY(a, b, c) a = c;
REGISTER_TABLE
#undef ENTRY
ただし、私のお気に入りの使用法は、通信ハンドラーに関してです。
最初に、各コマンド名とコードを含む通信テーブルを作成します。
#define COMMAND_TABLE \
ENTRY(RESERVED, reserved, 0x00) \
ENTRY(COMMAND1, command1, 0x01) \
ENTRY(COMMAND2, command2, 0x02) \
...
ENTRY(COMMANDX, commandX, 0x0X) \
大文字は列挙型に使用され、小文字は関数名に使用されるため、表には大文字と小文字の両方の名前があります。
次に、各コマンドの構造体を定義して、各コマンドがどのように見えるかを定義します。
typedef struct {...}command1_cmd_t;
typedef struct {...}command2_cmd_t;
etc.
同様に、コマンド応答ごとに構造体を定義します。
typedef struct {...}command1_resp_t;
typedef struct {...}command2_resp_t;
etc.
次に、コマンド コードの列挙を定義します。
enum
{
#define ENTRY(a,b,c) a##_CMD = c,
COMMAND_TABLE
#undef ENTRY
};
コマンドの長さの列挙を定義できます。
enum
{
#define ENTRY(a,b,c) a##_CMD_LENGTH = sizeof(b##_cmd_t);
COMMAND_TABLE
#undef ENTRY
};
応答の長さの列挙を定義できます。
enum
{
#define ENTRY(a,b,c) a##_RESP_LENGTH = sizeof(b##_resp_t);
COMMAND_TABLE
#undef ENTRY
};
次のように、コマンドがいくつあるかを判断できます。
typedef struct
{
#define ENTRY(a,b,c) uint8_t b;
COMMAND_TABLE
#undef ENTRY
} offset_struct_t;
#define NUMBER_OF_COMMANDS sizeof(offset_struct_t)
注: 実際に offset_struct_t をインスタンス化することはありません。コンパイラがコマンド定義の数を生成する方法として使用するだけです。
次に、次のように関数ポインターのテーブルを生成できることに注意してください。
p_func_t jump_table[NUMBER_OF_COMMANDS] =
{
#define ENTRY(a,b,c) process_##b,
COMMAND_TABLE
#undef ENTRY
}
そして私の関数プロトタイプ:
#define ENTRY(a,b,c) void process_##b(void);
COMMAND_TABLE
#undef ENTRY
最後に、これまでで最もクールな使い方として、送信バッファーの大きさをコンパイラーに計算させることができます。
/* reminder the sizeof a union is the size of its largest member */
typedef union
{
#define ENTRY(a,b,c) uint8_t b##_buf[sizeof(b##_cmd_t)];
COMMAND_TABLE
#undef ENTRY
}tx_buf_t
繰り返しになりますが、この共用体はオフセット構造体に似ており、インスタンス化されていません。代わりに、sizeof 演算子を使用して送信バッファー サイズを宣言できます。
uint8_t tx_buf[sizeof(tx_buf_t)];
これで、送信バッファー tx_buf が最適なサイズになりました。この通信ハンドラーにコマンドを追加すると、バッファーは常に最適なサイズになります。涼しい！
もう 1 つの用途は、オフセット テーブルを作成することです。メモリは組み込みシステムの制約になることが多いため、ジャンプ テーブルがスパース配列の場合、ジャンプ テーブルに 512 バイト (ポインターごとに 2 バイト X 256 の可能なコマンド) を使用したくありません。代わりに、可能なコマンドごとに 8 ビット オフセットのテーブルを作成します。次に、このオフセットを使用して実際のジャンプ テーブルにインデックスを付けますが、必要なのは NUM_COMMANDS * sizeof(pointer) だけです。私の場合、10 個のコマンドが定義されています。ジャンプ テーブルの長さは 20 バイトで、オフセット テーブルの長さは 256 バイトで、合計 512 バイトではなく 276 バイトです。次に、関数を次のように呼び出します。
jump_table[offset_table[command]]();
それ以外の
jump_table[command]();
次のようにオフセット テーブルを作成できます。
/* initialize every offset to 0 */
static uint8_t offset_table[256] = {0};
/* for each valid command, initialize the corresponding offset */
#define ENTRY(a,b,c) offset_table[c] = offsetof(offset_struct_t, b);
COMMAND_TABLE
#undef ENTRY
ここで、offsetof は「stddef.h」で定義されている標準ライブラリ マクロです。
副次的な利点として、コマンド コードがサポートされているかどうかを判断する非常に簡単な方法があります。
bool command_is_valid(uint8_t command)
{
/* return false if not valid, or true (non 0) if valid */
return offset_table[command];
}
これが、COMMAND_TABLE でコマンド バイト 0 を予約した理由でもあります。「process_reserved()」という関数を 1 つ作成できます。この関数は、無効なコマンド バイトがオフセット テーブルのインデックスに使用された場合に呼び出されます。
于 2012-02-21T20:13:14.977 に答える
42
X-Macro は、基本的にパラメーター化されたテンプレートです。したがって、いくつかの形でいくつかの類似したものが必要な場合、それらは仕事に適したツールです. 抽象フォームを作成し、さまざまなルールに従ってインスタンス化することができます。
X マクロを使用して列挙値を文字列として出力します。そして、それに遭遇して以来、「ユーザー」マクロを各要素に適用するこの形式を強く好みます。複数のファイルを含めると、作業がはるかに困難になります。
/* x-macro constructors for error and type
enums and string tables */
#define AS_BARE(a) a ,
#define AS_STR(a) #a ,
#define ERRORS(_) \
_(noerror) \
_(dictfull) _(dictstackoverflow) _(dictstackunderflow) \
_(execstackoverflow) _(execstackunderflow) _(limitcheck) \
_(VMerror)
enum err { ERRORS(AS_BARE) };
char *errorname[] = { ERRORS(AS_STR) };
/* puts(errorname[(enum err)limitcheck]); */
オブジェクトタイプに基づいた関数ディスパッチにも使用しています。ここでも、列挙値の作成に使用したのと同じマクロをハイジャックします。
#define TYPES(_) \
_(invalid) \
_(null) \
_(mark) \
_(integer) \
_(real) \
_(array) \
_(dict) \
_(save) \
_(name) \
_(string) \
/*enddef TYPES */
#define AS_TYPE(_) _ ## type ,
enum { TYPES(AS_TYPE) };
マクロを使用すると、マクロ定義 (TYPES マクロ) からの裸のトークンを使用してさまざまな形式を構築するため、すべての配列インデックスが関連する列挙値と一致することが保証されます。
typedef void evalfunc(context *ctx);
void evalquit(context *ctx) { ++ctx->quit; }
void evalpop(context *ctx) { (void)pop(ctx->lo, adrent(ctx->lo, OS)); }
void evalpush(context *ctx) {
push(ctx->lo, adrent(ctx->lo, OS),
pop(ctx->lo, adrent(ctx->lo, ES)));
}
evalfunc *evalinvalid = evalquit;
evalfunc *evalmark = evalpop;
evalfunc *evalnull = evalpop;
evalfunc *evalinteger = evalpush;
evalfunc *evalreal = evalpush;
evalfunc *evalsave = evalpush;
evalfunc *evaldict = evalpush;
evalfunc *evalstring = evalpush;
evalfunc *evalname = evalpush;
evalfunc *evaltype[stringtype/*last type in enum*/+1];
#define AS_EVALINIT(_) evaltype[_ ## type] = eval ## _ ;
void initevaltype(void) {
TYPES(AS_EVALINIT)
}
void eval(context *ctx) {
unsigned ades = adrent(ctx->lo, ES);
object t = top(ctx->lo, ades, 0);
if ( isx(t) ) /* if executable */
evaltype[type(t)](ctx); /* <--- the payoff is this line here! */
else
evalpush(ctx);
}
このように X マクロを使用すると、実際にコンパイラが役立つエラー メッセージを表示するのに役立ちます。上記の evalarray 関数は、私の要点から逸れるので省略しました。しかし、上記のコードをコンパイルしようとすると (もちろん、他の関数呼び出しをコメントアウトし、コンテキストにダミーの typedef を提供します)、コンパイラは関数が見つからないというエラーを出します。追加する新しい型ごとに、このモジュールを再コンパイルするときにハンドラーを追加するように通知されます。したがって、X マクロは、プロジェクトが拡大しても並列構造が損なわれないことを保証するのに役立ちます。
編集：
この回答により、私の評判が 50% 向上しました。それでは、もう少しです。以下は、質問に答える否定的な例です: X-Macros を使用しない場合は?
この例は、任意のコード フラグメントを X-"record" にパッキングする方法を示しています。私は最終的にプロジェクトのこのブランチを放棄し、後の設計ではこの戦略を使用しませんでした (試してみたいからではありません)。どういうわけか、それは扱いにくくなりました。確かにマクロは X6 という名前になっています。ある時点で 6 つの引数があったからです。しかし、マクロ名を変更するのにうんざりしました。
/* Object types */
/* "'X'" macros for Object type definitions, declarations and initializers */
// a b c d
// enum, string, union member, printf d
#define OBJECT_TYPES \
X6( nulltype, "null", int dummy , ("<null>")) \
X6( marktype, "mark", int dummy2 , ("<mark>")) \
X6( integertype, "integer", int i, ("%d",o.i)) \
X6( booleantype, "boolean", bool b, (o.b?"true":"false")) \
X6( realtype, "real", float f, ("%f",o.f)) \
X6( nametype, "name", int n, ("%s%s", \
(o.flags & Fxflag)?"":"/", names[o.n])) \
X6( stringtype, "string", char *s, ("%s",o.s)) \
X6( filetype, "file", FILE *file, ("<file %p>",(void *)o.file)) \
X6( arraytype, "array", Object *a, ("<array %u>",o.length)) \
X6( dicttype, "dict", struct s_pair *d, ("<dict %u>",o.length)) \
X6(operatortype, "operator", void (*o)(), ("<op>")) \
#define X6(a, b, c, d) #a,
char *typestring[] = { OBJECT_TYPES };
#undef X6
// the Object type
//forward reference so s_object can contain s_objects
typedef struct s_object Object;
// the s_object structure:
// a bit convoluted, but it boils down to four members:
// type, flags, length, and payload (union of type-specific data)
// the first named union member is integer, so a simple literal object
// can be created on the fly:
// Object o = {integertype,0,0,4028}; //create an int object, value: 4028
// Object nl = {nulltype,0,0,0};
struct s_object {
#define X6(a, b, c, d) a,
enum e_type { OBJECT_TYPES } type;
#undef X6
unsigned int flags;
#define Fread 1
#define Fwrite 2
#define Fexec 4
#define Fxflag 8
size_t length; //for lint, was: unsigned int
#define X6(a, b, c, d) c;
union { OBJECT_TYPES };
#undef X6
};
大きな問題の 1 つは、printf フォーマット文字列でした。クールに見えますが、ただのまぼろしです。1 つの関数でしか使用されないため、マクロを使いすぎると、一緒にすべき情報が実際に分離されてしまいます。そして、それ自体では関数を読み取れなくなります。この難読化は、このようなデバッグ機能では二重に不幸です。
//print the object using the type's format specifier from the macro
//used by O_equal (ps: =) and O_equalequal (ps: ==)
void printobject(Object o) {
switch (o.type) {
#define X6(a, b, c, d) \
case a: printf d; break;
OBJECT_TYPES
#undef X6
}
}
だから、夢中にならないでください。私がしたように。
于 2011-07-09T18:15:48.090 に答える
8
人気のある大規模なプロジェクトによる X-Macros の実際の使用例:
Java ホットスポット
Java®プログラミング言語用のOracle HotSpot仮想マシンには、そのようglobals.hppに使用するファイルがありますRUNTIME_FLAGS。
ソースコードを参照してください:
クロム
net_error_list.h のネットワーク エラーのリストは、次の形式のマクロ展開の非常に長いリストです。
NET_ERROR(IO_PENDING, -1)
これは、同じディレクトリのnet_errors.hによって使用されます。
enum Error {
OK = 0,
#define NET_ERROR(label, value) ERR_ ## label = value,
#include "net/base/net_error_list.h"
#undef NET_ERROR
};
このプリプロセッサ マジックの結果は次のとおりです。
enum Error {
OK = 0,
ERR_IO_PENDING = -1,
};
この特定の使用法について私が気に入らないのは、定数の名前がERR_. この例でNET_ERROR(IO_PENDING, -100)は、定数 を定義しERR_IO_PENDINGます。
の単純なテキスト検索を使用してERR_IO_PENDINGも、この定数が定義されている場所を確認することはできません。代わりに、定義を見つけるには、 を検索する必要がありIO_PENDINGます。これにより、コードのナビゲートが難しくなり、コード ベース全体の難読化が増します。
于 2011-07-09T16:28:45.960 に答える
5
私は、列挙値の反復と各列挙値の文字列表現の取得をサポートする「豊富な列挙」を作成するために X マクロを使用するのが好きです。
#define MOUSE_BUTTONS \
X(LeftButton, 1) \
X(MiddleButton, 2) \
X(RightButton, 4)
struct MouseButton {
enum Value {
None = 0
#define X(name, value) ,name = value
MOUSE_BUTTONS
#undef X
};
static const int *values() {
static const int a[] = {
None,
#define X(name, value) name,
MOUSE_BUTTONS
#undef X
-1
};
return a;
}
static const char *valueAsString( Value v ) {
#define X(name, value) static const char str_##name[] = #name;
MOUSE_BUTTONS
#undef X
switch ( v ) {
case None: return "None";
#define X(name, value) case name: return str_##name;
MOUSE_BUTTONS
#undef X
}
return 0;
}
};
これは列挙型を定義するだけでなく、次のMouseButton::Valueようなことも可能にします
// Print names of all supported mouse buttons
for ( const int *mb = MouseButton::values(); *mb != -1; ++mb ) {
std::cout << MouseButton::valueAsString( (MouseButton::Value)*mb ) << "\n";
}
于 2015-02-20T09:23:25.420 に答える
5
私は非常に大規模な X マクロを使用して、INI ファイルの内容を構成構造体にロードします。とりわけ、その構造体を中心に展開します。
これは私の "configuration.def" -ファイルがどのように見えるかです:
#define NMB_DUMMY(...) X(__VA_ARGS__)
#define NMB_INT_DEFS \
TEXT("long int") , long , , , GetLongValue , _ttol , NMB_SECT , SetLongValue ,
#define NMB_STR_DEFS NMB_STR_DEFS__(TEXT("string"))
#define NMB_PATH_DEFS NMB_STR_DEFS__(TEXT("path"))
#define NMB_STR_DEFS__(ATYPE) \
ATYPE , basic_string<TCHAR>* , new basic_string<TCHAR>\
, delete , GetValue , , NMB_SECT , SetValue , *
/* X-macro starts here */
#define NMB_SECT "server"
NMB_DUMMY(ip,TEXT("Slave IP."),TEXT("10.11.180.102"),NMB_STR_DEFS)
NMB_DUMMY(port,TEXT("Slave portti."),TEXT("502"),NMB_STR_DEFS)
NMB_DUMMY(slaveid,TEXT("Slave protocol ID."),0xff,NMB_INT_DEFS)
.
. /* And so on for about 40 items. */
それは少し紛らわしいです、私は認めます。すべてのフィールドマクロの後に、これらすべての型宣言を実際に書きたくないことがすぐに明らかになります。(心配しないでください。簡潔にするために省略したすべてを説明する大きなコメントがあります。)
そして、これが構成構造体を宣言する方法です。
typedef struct {
#define X(ID,DESC,DEFVAL,ATYPE,TYPE,...) TYPE ID;
#include "configuration.def"
#undef X
basic_string<TCHAR>* ini_path; //Where all the other stuff gets read.
long verbosity; //Used only by console writing functions.
} Config;
次に、コードでは、最初にデフォルト値が構成構造体に読み込まれます。
#define X(ID,DESC,DEFVAL,ATYPE,TYPE,CONSTRUCTOR,DESTRUCTOR,GETTER,STRCONV,SECT,SETTER,...) \
conf->ID = CONSTRUCTOR(DEFVAL);
#include "configuration.def"
#undef X
次に、ライブラリ SimpleIni を使用して、次のように INI が構成構造体に読み込まれます。
#define X(ID,DESC,DEFVAL,ATYPE,TYPE,CONSTRUCTOR,DESTRUCTOR,GETTER,STRCONV,SECT,SETTER,DEREF...)\
DESTRUCTOR (conf->ID);\
conf->ID = CONSTRUCTOR( ini.GETTER(TEXT(SECT),TEXT(#ID),DEFVAL,FALSE) );\
LOG3A(<< left << setw(13) << TEXT(#ID) << TEXT(": ") << left << setw(30)\
<< DEREF conf->ID << TEXT(" (") << DEFVAL << TEXT(").") );
#include "configuration.def"
#undef X
また、同じ名前 (GNU ロング フォーム) でフォーマットされているコマンドライン フラグからのオーバーライドは、ライブラリ SimpleOpt を使用して、次のように適用されます。
enum optflags {
#define X(ID,...) ID,
#include "configuration.def"
#undef X
};
CSimpleOpt::SOption sopt[] = {
#define X(ID,DESC,DEFVAL,ATYPE,TYPE,...) {ID,TEXT("--") #ID TEXT("="), SO_REQ_CMB},
#include "configuration.def"
#undef X
SO_END_OF_OPTIONS
};
CSimpleOpt ops(argc,argv,sopt,SO_O_NOERR);
while(ops.Next()){
switch(ops.OptionId()){
#define X(ID,DESC,DEFVAL,ATYPE,TYPE,CONSTRUCTOR,DESTRUCTOR,GETTER,STRCONV,SECT,...) \
case ID:\
DESTRUCTOR (conf->ID);\
conf->ID = STRCONV( CONSTRUCTOR ( ops.OptionArg() ) );\
LOG3A(<< TEXT("Omitted ")<<left<<setw(13)<<TEXT(#ID)<<TEXT(" : ")<<conf->ID<<TEXT(" ."));\
break;
#include "configuration.def"
#undef X
}
}
など、同じマクロを使用して --help -flag 出力とサンプルのデフォルトの ini ファイルを出力します。configuration.def は私のプログラムに 8 回含まれています。「丸い穴に四角いペグ」、多分; 実際に有能なプログラマーはこれをどのように進めますか? たくさんのループと文字列処理？
于 2015-07-17T15:56:28.737 に答える