Directive (programming)

<h2 id="the-c-preprocessor">The C preprocessor</h2>
<p class="note">Main article: <a href="/facts/C_preprocessor/KuhuxKYP">C preprocessor</a></p>
<p>In <a href="/facts/C_(programming_language)/Ky2No763">C</a> and <a href="/facts/C%2B%2B/Et0F2qn9">C++</a>, the language supports a simple <a href="/facts/Macro_(computer_science)/7abAsm1o">macro</a> <a href="/facts/Preprocessor/arTRL5RG">preprocessor</a>. Source lines that should be handled by the preprocessor, such as #define and #include are referred to as <i>preprocessor directives</i>.
</p><p>Syntactic constructs similar to C's preprocessor directives, such as <a href="/facts/C_Sharp_(programming_language)/UC2gxeyb">C#</a>'s #if, are also typically called "directives", although in these cases there may not be any real preprocessing phase involved.
</p><p>All preprocessor commands begin with a hash symbol (#) with the exception of the keywords export, import and module in <a href="/facts/C%2B%2B/Et0F2qn9">C++</a> (handled by the preprocessor prior to <a href="/facts/C%2B%2B26/vnzBD243">C++26</a>).<a class="footnote-ref" id="fnref:1" href="#fn:1"><sup>1</sup></a>
</p>
<h2 id="history">History</h2>
<p>Directives date to <a href="/facts/JOVIAL/1xLISDrj">JOVIAL</a>.<a class="footnote-ref" id="fnref:2" href="#fn:2"><sup>2</sup></a>
</p><p><a href="/facts/COBOL/wVnhqs0k">COBOL</a> has a COPY directive.
</p><p>In  <a href="/facts/ALGOL_68/NTnc9fy7">ALGOL 68</a>, directives are known as <a href="/facts/ALGOL_68/NTnc9fy7">pragmats</a> (from "pragmatic"), and denoted pragmat or pr; in newer languages, notably C, this has been abbreviated to "pragma" (no 't').
</p><p>A common use of pragmats in ALGOL 68 is in specifying a <a href="/facts/Stropping_(syntax)/fyfK3KkV">stropping</a> 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:
</p>
.PR POINT .PR
.PR UPPER .PR
.PR RES .PR
'pr' quote 'pr'

<p>Today directives are best known in the C language, of early 1970s vintage, and continued through the current <a href="/facts/C99/o5uMWjTQ">C99</a> standard, where they are either instructions to the <a href="/facts/C_preprocessor/KuhuxKYP">C preprocessor</a>, or, in the form of #pragma, directives to the compiler itself. They are also used to some degree in more modern languages; see below.
</p>
<h2 id="other-languages">Other languages</h2>
<ul><li>In <a href="/facts/Ada_(programming_language)/Y2yHel4l">Ada</a>, compiler directives are called pragmas (short for "pragmatic information").</li>
<li>In <a href="/facts/Common_Lisp/mq1pRbSF">Common Lisp</a>, directives are called declarations, and are specified using the declare construct (also proclaim or declaim).<a class="footnote-ref" id="fnref:3" href="#fn:3"><sup>3</sup></a> 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.</li>
<li>In <a href="/facts/Turbo_Pascal/2aWFEk9z">Turbo Pascal</a>, directives are called significant comments, because in the language <a href="/facts/Grammar/vprQsHIR">grammar</a> they follow the same syntax as <a href="/facts/Comment_(computer_programming)/Q8hHFq8h">comments</a>. In Turbo Pascal, a significant comment is a comment whose first character is a <a href="/facts/Dollar_sign/4CroUuPn">dollar sign</a> and whose second character is a letter; for example, the equivalent of C's #include "file" directive is the significant comment {$I "file"}.</li>
<li>In <a href="/facts/Perl/fx31kjlT">Perl</a>, the <a href="/facts/Keyword_(computer_programming)/pHDlUUgY">keyword</a> "<a href="http://perldoc.perl.org/functions/use.html">use</a>", which imports modules, can also be used to specify directives, such as use strict; or use utf8;.</li>
<li><a href="/facts/Haskell_(programming_language)/4Htv9WLu">Haskell</a> pragmas are specified using a specialized comment syntax, e.g. {-# INLINE foo #-}.<a class="footnote-ref" id="fnref:4" href="#fn:4"><sup>4</sup></a></li>
<li><a href="/facts/PHP/vU6YRJX0">PHP</a> uses the directive declare(strict_types=1).</li>
<li><a href="/facts/Python_(programming_language)/YbuGqofa">Python</a> has two directives – from __future__ import feature (defined in <a href="https://www.python.org/dev/peps/pep-0236/">PEP 236 -- Back to the __future__</a>), 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 <a href="https://www.python.org/dev/peps/pep-0263/">PEP 263 -- Defining Python Source Code Encodings</a>). A more general directive statement was proposed and rejected in <a href="https://www.python.org/dev/peps/pep-0244/">PEP 244 -- The `directive' statement</a>; these all date to 2001.</li>
<li><a href="/facts/ECMAScript/M7nDHsB5">ECMAScript</a> 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.</li>
<li>In <a href="/facts/Visual_Basic/7QMXM6fP">Visual Basic</a>, the keyword "Option" is used for directives:
<ul><li>Option Explicit On|Off - When on disallows implicit declaration of variables at first use requiring explicit declaration beforehand.</li>
<li>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).</li>
<li>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).</li>
<li>Option Strict On|Off - When on disallows:
<ul><li>typeless programming - where declarations which lack an explicit type are implicitly typed as Object.</li>
<li>late-binding (i.e. dynamic dispatch to CLR, DLR, and COM objects) on values statically typed as Object.</li>
<li>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).</li></ul></li>
<li>Option Infer On|Off - When on enables the compiler to infer the type of local variables from their initializers.</li></ul></li>
<li>In <a href="/facts/Ruby_(programming_language)/BeYSaPSR">Ruby</a>, interpreter directives are referred to as pragmas and are specified by top-of-file comments that follow a key: value notation. For example, coding: UTF-8 indicates that the file is encoded via the <a href="/facts/UTF-8/xlaVHSyf">UTF-8</a> <a href="/facts/Character_encoding/ShJHIMoA">character encoding</a>.</li>
<li>In <a href="/facts/C_Sharp_(programming_language)/UC2gxeyb">C#</a>, compiler directives are called pre-processing directives.  There are a number of different compiler directives including #pragma, which is specifically used to control compiler warnings and debugger checksums.<a class="footnote-ref" id="fnref:5" href="#fn:5"><sup>5</sup></a><a class="footnote-ref" id="fnref:6" href="#fn:6"><sup>6</sup></a></li>
<li>The <a href="/facts/SQLite/1PwYzIft">SQLite</a> <a href="/facts/DBMS/VYcpkevb">DBMS</a> includes a PRAGMA directive that is used to introduce commands that are not compatible with other DBMS.<a class="footnote-ref" id="fnref:7" href="#fn:7"><sup>7</sup></a></li>
<li>In <a href="/facts/Solidity/D76w4DAc">Solidity</a>, compiler directives are called pragmas, and are specified using the `pragma` keyword.<a class="footnote-ref" id="fnref:8" href="#fn:8"><sup>8</sup></a></li></ul>
<h3>Assembly language</h3>
<ul><li>In <a href="/facts/Assembly_language/7XuV0cla">assembly language</a>, directives, also referred to as pseudo-operations or "pseudo-ops", generally specify such information as the target machine, mark separations between code sections, define and change assembly-time variables, define macros, designate conditional and repeated code, define reserved memory areas, and so on.  Some, but not all, assemblers use a specific syntax to differentiate pseudo-ops from instruction mnemonics, such as prefacing the pseudo-op with a period, such as the pseudo-op .END, which might direct the assembler to stop assembling code.</li></ul>
<h3>PL/SQL</h3>
<ul><li><a href="/facts/Oracle_Corporation/0z14FygH">Oracle Corporation</a>'s <a href="/facts/PL/SQL/LLghPhdc">PL/SQL</a> procedural language includes a set of compiler directives, known as "pragmas".<a class="footnote-ref" id="fnref:9" href="#fn:9"><sup>9</sup></a></li></ul>
<h2 id="see-also">See also</h2>
<ul><li><a href="/facts/Pragma_once/LNCNmtAQ">#pragma once</a> – Preprocessor directive in C and C++</li></ul>
<h2 id="footnotes">Footnotes</h2>

<ul><li><a href="/facts/Guy_L._Steele/amHwRA1l">Steele, Guy L.</a> (1990). <i><a href="/facts/Common_Lisp_the_Language/vmC2pYqS">Common Lisp the Language</a></i>. Digital Press. pp. 215–237. <a href="/facts/ISBN_(identifier)/15AdSPa9">ISBN</a> 1-55558-041-6.</li></ul>

<h2 id="external-links">External links</h2>
<ul><li><a href="http://www.openmp.org">OpenMP Website</a></li>
<li><a href="http://www.openacc.org">OpenACC Website</a></li>
<li><a href="https://web.archive.org/web/20130616205308/http://openhmpp.org/">OpenHMPP Website</a></li></ul>

<h2 id="references">References</h2>

<ol>
<li id="fn:1"><p>"P1857R1 - Modules Dependency Discovery". <a href="https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p1857r1.html" target="_blank">https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p1857r1.html</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></p></li>
<li id="fn:2"><p>"Chapter 17 - Directives" (PDF). Computer Programming Manual for JOVIAL (J73) Language (PDF) (Technical report). June 1981. pp. 243–263. RADC-TR-81-143. Retrieved May 28, 2023. <a href="https://apps.dtic.mil/sti/pdfs/ADA101061.pdf#page=248" target="_blank">https://apps.dtic.mil/sti/pdfs/ADA101061.pdf#page=248</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></p></li>
<li id="fn:3"><p>Steele 1990, Chapter 9: Declarations, p. 215–237. - Steele, Guy L. (1990). Common Lisp the Language. Digital Press. pp. 215–237. ISBN 1-55558-041-6. <a href="#fnref:3" class="footnote-back-ref">↩</a></p></li>
<li id="fn:4"><p>"7.20. Pragmas". GHC 7.8.3 Documentation. Retrieved 18 July 2014. <a href="http://www.haskell.org/ghc/docs/7.8.3/html/users_guide/pragmas.html" target="_blank">http://www.haskell.org/ghc/docs/7.8.3/html/users_guide/pragmas.html</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></p></li>
<li id="fn:5"><p>dotnet-bot. "Lexical structure - C# language specification". docs.microsoft.com. Retrieved 2019-11-01. <a href="https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/lexical-structure" target="_blank">https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/lexical-structure</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></p></li>
<li id="fn:6"><p>BillWagner. "#pragma - C# Reference". docs.microsoft.com. Retrieved 2019-11-01. <a href="https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/preprocessor-directives/preprocessor-pragma" target="_blank">https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/preprocessor-directives/preprocessor-pragma</a> <a href="#fnref:6" class="footnote-back-ref">↩</a></p></li>
<li id="fn:7"><p>"Pragma statements supported by SQLite". www.sqlite.org. <a href="https://www.sqlite.org/pragma.html" target="_blank">https://www.sqlite.org/pragma.html</a> <a href="#fnref:7" class="footnote-back-ref">↩</a></p></li>
<li id="fn:8"><p>"Layout of a Solidity Source File — Solidity 0.8.27 documentation". docs.soliditylang.org. Retrieved 2024-06-03. <a href="https://docs.soliditylang.org/en/latest/layout-of-source-files.html#pragmas" target="_blank">https://docs.soliditylang.org/en/latest/layout-of-source-files.html#pragmas</a> <a href="#fnref:8" class="footnote-back-ref">↩</a></p></li>
<li id="fn:9"><p>Feuerstein, Steven; Pribyl, Bill (23 January 2014). Oracle PL/SQL Programming (6 ed.). O'Reilly Media, Inc. (published 2014). 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 [...] <a href="9781449324414" target="_blank">9781449324414</a> <a href="#fnref:9" class="footnote-back-ref">↩</a></p></li>
</ol>

Directive (programming) open-in-new

Directive (programming)