In computer programming, a directive pragma (from "pragmatic") is a language construct that specifies how a compiler (or assembler or interpreter) should process its input. Directives are not part of the language proper – they are not part of the grammar, and may vary from compiler to compiler – but instead function either as an in-band form of a command-line option, specifying compiler behavior, or are processed by a preprocessor. In some cases directives specify global behavior, while in other cases they only affect a local section, such as a block of programming code. In some cases, such as some C pragmas, directives are optional compiler hints, and may be ignored, but normally they are prescriptive, and must be followed. However, a directive does not perform any action in the language itself, but rather only a change in the behavior of the compiler.
This term could be used to refer to proprietary third party tags and commands (or markup) embedded in code that result in additional executable processing that extend the existing compiler, assembler and language constructs present in the development environment. The term "directive" is also applied in a variety of ways that are similar to the term command.
The C preprocessor
Syntactic constructs similar to C's preprocessor directives, such as C#'s
#if, are also typically called "directives", although in these cases there may not be any real preprocessing phase involved.
All preprocessor commands begin with a hash symbol (#).
A common use of pragmats in ALGOL 68 is in specifying a stropping regime, meaning "how keywords are indicated". Various such directives follow, specifying the POINT, UPPER, RES (reserved), or quote regimes. Note the use of stropping for the pragmat keyword itself (abbreviated pr), either in the POINT or quote regimes:
.PR POINT .PR .PR UPPER .PR .PR RES .PR 'pr' quote 'pr'
Today directives are best known in the C language, of early 1970s vintage, and continued through the current C99 standard, where they are either instructions to the C preprocessor, or, in the form of
#pragma, directives to the compiler itself. They are also used to some degree in more modern languages; see below.
In Ada, compiler directives are called pragmas (short for "pragmatic information").
In Common Lisp, directives are called declarations, and are specified using the
declare construct (also
declaim). With one exception, declarations are optional, and do not affect the semantics of the program. The one exception is
special, which must be specified where appropriate.
In Turbo Pascal, directives are called significant comments, because in the language grammar they follow the same syntax as comments. In Turbo Pascal, a significant comment is a comment whose first character is a dollar sign and whose second character is a letter; for example, the equivalent of C's
#include "file" directive is the significant comment
Python has two directives –
from __future__ import feature (defined in PEP 236 -- Back to the __future__), which changes language features (and uses the existing module import syntax, as in Perl), and the
coding directive (in a comment) to specify the encoding of a source code file (defined in PEP 263 -- Defining Python Source Code Encodings). A more general directive statement was proposed and rejected in PEP 244 -- The `directive' statement; these all date to 2001.
ECMAScript also adopts the
use syntax for directives, with the difference that pragmas are declared as string literals (e.g.
"use strict";, or
"use asm";), rather than a function call.
In Visual Basic, the keyword "
Option" is used for directives:
Option Explicit On|Off- When on disallows implicit declaration of variables at first use requiring explicit declaration beforehand.
Option Compare Binary- Results in string comparisons based on a sort order derived from the internal binary representations of the characters - e.g. for the English/European code page (ANSI 1252) A < B < E < Z < a < b < e < z < À < Ê < Ø < à < ê < ø. Affects intrinsic operators (e.g. =, <>, <, >), the Select Case block, and VB runtime library string functions (e.g. InStr).
Option Compare Text- Results in string comparisons based on a case-insensitive text sort order determined by your system's locale - e.g. for the English/European code page (ANSI 1252) (A=a) < (À = à) < (B=b) < (E=e) < (Ê = ê) < (Z=z) < (Ø = ø). Affects intrinsic operators (e.g. =, <>, <, >), the Select Case block, and VB runtime library string functions (e.g. InStr).
Option Strict On|Off- When on disallows:
- typeless programming - where declarations which lack an explicit type are implicitly typed as Object.
- late-binding (i.e. dynamic dispatch to CLR, DLR, and COM objects) on values statically typed as Object.
- implicit narrowing conversions - requiring all conversions to narrower types (e.g. from Long to Integer, Object to String, Control to TextBox) be explicit in code using conversion operators (e.g. CInt, DirectCast, CType).
Option Infer On|Off- When on enables the compiler to infer the type of local variables from their initializers.
In assembly language, directives generally specify such information as the target platform, mark the separations between sections, and so on. For instance, the commonly seen directive "ALIGN", which inserts in the current section as many bytes as needed to preserve word-alignment, is generally referred to[by whom?] as a "directive", despite the fact that it does correspond to a particular construct in the generated code.
|This article needs additional citations for verification. (December 2013) (Learn how and when to remove this template message)|
- Steele 1990, Chapter 9: Declarations, p. 215–237.
- "7.20. Pragmas". GHC 7.8.3 Documentation. Retrieved 18 July 2014.
- Feuerstein, Steven; Pribyl, Bill (2014). Oracle PL/SQL Programming (6 ed.). O'Reilly Media, Inc. ISBN 9781449324414. Retrieved 2016-06-16.
PL/SQL has a PRAGMA keyword with the following syntax: PRAGMA instruction_to_compiler; [...] PL/SQL offers several pragmas [...]