Makro s parametry

Minule jsem si ukázali, jak definovat jednoduché makro bez parametrů, nicméně podobně jako funkce i makro může mít parametry.

#define moje_gets(s, size) fgets((s), (size), stdin)

V dílu o standardním vstupu jsem haněl funkci gets a doporučoval místo ní fgets. Pokud programátora nebaví opisovat parametr stdin, může si pomoci výše uvedeným makrem. Je dobrým zvykem dávat parametry makra do závorek. Kdybychom třeba definovali makro pro násobení

#define KRAT(a, b) a * b
/*
Správně je
#define KRAT(a, b) ((a) * (b))
*/

Rozvine se při volání

KRAT(1 + 2, 3 + 4)

na

1 + 2 * 3 + 4

Občas se hodí makro pro menší ze dvou čísel. Zde pomůže ternární operátor.

#define MINIMUM(a, b) ((a) < (b) ? (a) : (b))

Zejména v souvislosti s makry se často vyskytuje také operátor zapomenutí, čárka.

Výraz x, y znamená nejprve vyhodnoť podvýraz x a hodnotu zapomeň, potom vyhodnoť podvýraz y a jeho hodnota bude výsledkem celého výrazu x, y. Celá konstrukce má smysl, pokud je na výrazu x podstatný jen jeho vedlejší efekt. Pokud nás například z ladících důvodu zajímá celkový počet volání putchar, můžeme jej volat prostřednictvím následujícího makra.

int pocet_volani = 0;

#define VOLEJ_PUTCHAR(c) (pocet_volani++, putchar((c)))

Je dobré si uvědomit, že takto definované makro umožňuje přístup i k návratové hodnotě volání putchar, což by definice pomocí dvou příkazů ukončených středníkem neumožňovala. V programu tedy můžeme makro volat i takhle.

int c = VOLEJ_PUTCHAR('A');
if (c == EOF) {
  puts("Chyba");
}

Parametry makra samozřejmě nemusejí být jen proměnné nebo výrazy.

#define PROHOD(typ, a, b) {typ c; c = a; a = b; b = c;}

Uvedené makro prohodí obsah dvou proměnných libovolného typu. Volalo by se například

int i = 1, j = 2;

PROHOD(int, i, j)

Rušení makra

Při běžném způsobu programování v C není obvykle třeba definici makra rušit. Výjimka může nastat, pokud chceme definovat makro jen pro použití v hlavičkovém souboru, ale nechceme, aby bylo platné i v souboru, který jej inkluduje. Také se může stát, že nám vadí makro z nějakého hlavičkového souboru, jehož obsah nemůžeme ovlivnit. Zde pomůže příkaz #undef

#undef MAKRO

/* nebo obecněji */

#ifdef MAKRO
#undef MAKRO
#endif

Drobnosti

Některé direktivy preprocesoru často neznají ani ostřílení C programátoři. Sem patří #, ## a #line. Pomocí # lze parametr makra po rozvinutí obalit uvozovkami a udělat z něj řetězcovou konstantu, ## zase spojuje 2 tokeny do jednoho identifikátoru.

#include <stdio.h>
#define PRINT_TOKEN(x) puts(#x)
#define PRINT_I(x) printf("%i\n", i##x)

int main(void) {

  int i1 = 7, i2 = 8, i3 = 9;

/* Pokud uhodnete, co vypíše PRINT_TOKEN(1 + 1); rozumíte preprocesoru */

  PRINT_TOKEN(1 + 1);
  PRINT_I(1); /* printf("%i\n", i1); */
  PRINT_I(2); /* printf("%i\n", i2); */
  PRINT_I(3); /* printf("%i\n", i3); */
  return 0;
}

O něco častěji se používá #pragma, tato direktiva má obvykle ještě parametr. Pokud mu překladač nerozumí, musí podle normy celou direktivu ignorovat. V opačném případě ji implementačně závislým způsobem zpracuje. Například pomocí #pragma warning( disable : 4507 ) můžeme v MS Visual C++ zakázat jedno konkrétní varovné hlášení při překladu kódu, který se zdá překladači podezřelý. Při použití jiného překladače (např. gcc), který tuto syntaxi direktivy #pragma nezná, nedojde k chybě, pouze bude celá direktiva ignorována.

Standardní makra

ANSI C definuje několik maker

• __LINE__
  aktuální řádek ve zdrojovém souboru
• __FILE__
  jméno zdrojového souboru
• __TIME__
  čas překladu souboru
• __DATE__
  datum překladu souboru
• __TIMESTAMP__
  datum a čas modifikace souboru
• __STDC__
  1, pokud překládáme jako ANSI C (a ne např. C++), jinak nedefinováno

Direktiva #line ovlivňuje předdefinovaná makra __LINE__ a __FILE__.

#line 174 "soubor.c"

Tato direktiva může být použita v generátorech C kódu z nějakého metazdrojáku, případná chybová hlášení (využívající __LINE__ a __FILE__) přeloženého vygenerovaného C kódu tak mohou být nastavena na původní metakód. Běžný programátor tedy #line asi nikdy nevyužije.

Příklad pro dnešní díl

Při vývoji větších projektů je dobrým zvykem umožnit logování událostí za běhu programu. V distribuční verzi může (ale nemusí) být žádoucí logování potlačit a logovací kód vůbec nepřekládat a nelinkovat do programu. V příkladu definuji makro ZALOGUJ, které se rozvine buď na prázdný řetězec, nebo na výpis logovací hlášky v závislosti na symbolu LOGOVAT. Všimněte si použití standardních maker __FILE__ a __LINE__.

/*
  gcc program.c -o program -DLOGOVAT
*/
#include <stdio.h>
#ifdef LOGOVAT
#define ZALOGUJ(s) printf("%s:%i %s\n", __FILE__, __LINE__, (s))
#else
#define ZALOGUJ(s)
#endif

int main(void) {
  ZALOGUJ("Začátek programu");
  return 0;
}

Pokračování příště

Příště se podíváme podrobněji na funkce. Postupně se také začneme zabývat projekty s větším počtem zdrojových souborů.