gcc/c-family/c-pragma.h

   1 /* Pragma related interfaces.
   2    Copyright (C) 1995-2013 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GCC_C_PRAGMA_H
  21 #define GCC_C_PRAGMA_H
  22
  23 #include "cpplib.h" /* For enum cpp_ttype.  */
  24
  25 /* Pragma identifiers built in to the front end parsers.  Identifiers
  26    for ancillary handlers will follow these.  */
  27 typedef enum pragma_kind {
  28   PRAGMA_NONE = 0,
  29
  30   PRAGMA_OMP_ATOMIC,
  31   PRAGMA_OMP_BARRIER,
  32   PRAGMA_OMP_CANCEL,
  33   PRAGMA_OMP_CANCELLATION_POINT,
  34   PRAGMA_OMP_CRITICAL,
  35   PRAGMA_OMP_DECLARE_REDUCTION,
  36   PRAGMA_OMP_DISTRIBUTE,
  37   PRAGMA_OMP_END_DECLARE_TARGET,
  38   PRAGMA_OMP_FLUSH,
  39   PRAGMA_OMP_FOR,
  40   PRAGMA_OMP_MASTER,
  41   PRAGMA_OMP_ORDERED,
  42   PRAGMA_OMP_PARALLEL,
  43   PRAGMA_OMP_SECTION,
  44   PRAGMA_OMP_SECTIONS,
  45   PRAGMA_OMP_SIMD,
  46   PRAGMA_OMP_SINGLE,
  47   PRAGMA_OMP_TARGET,
  48   PRAGMA_OMP_TASK,
  49   PRAGMA_OMP_TASKGROUP,
  50   PRAGMA_OMP_TASKWAIT,
  51   PRAGMA_OMP_TASKYIELD,
  52   PRAGMA_OMP_THREADPRIVATE,
  53   PRAGMA_OMP_TEAMS,
  54
  55   /* Top level clause to handle all Cilk Plus pragma simd clauses.  */
  56   PRAGMA_CILK_SIMD,
  57
  58   PRAGMA_GCC_PCH_PREPROCESS,
  59   PRAGMA_IVDEP,
  60
  61   PRAGMA_FIRST_EXTERNAL
  62 } pragma_kind;
  63
  64
  65 /* All clauses defined by OpenMP 2.5, 3.0, 3.1 and 4.0.
  66    Used internally by both C and C++ parsers.  */
  67 typedef enum pragma_omp_clause {
  68   PRAGMA_OMP_CLAUSE_NONE = 0,
  69
  70   PRAGMA_OMP_CLAUSE_ALIGNED,
  71   PRAGMA_OMP_CLAUSE_COLLAPSE,
  72   PRAGMA_OMP_CLAUSE_COPYIN,
  73   PRAGMA_OMP_CLAUSE_COPYPRIVATE,
  74   PRAGMA_OMP_CLAUSE_DEFAULT,
  75   PRAGMA_OMP_CLAUSE_DEPEND,
  76   PRAGMA_OMP_CLAUSE_DEVICE,
  77   PRAGMA_OMP_CLAUSE_DIST_SCHEDULE,
  78   PRAGMA_OMP_CLAUSE_FINAL,
  79   PRAGMA_OMP_CLAUSE_FIRSTPRIVATE,
  80   PRAGMA_OMP_CLAUSE_FOR,
  81   PRAGMA_OMP_CLAUSE_FROM,
  82   PRAGMA_OMP_CLAUSE_IF,
  83   PRAGMA_OMP_CLAUSE_INBRANCH,
  84   PRAGMA_OMP_CLAUSE_LASTPRIVATE,
  85   PRAGMA_OMP_CLAUSE_LINEAR,
  86   PRAGMA_OMP_CLAUSE_MAP,
  87   PRAGMA_OMP_CLAUSE_MERGEABLE,
  88   PRAGMA_OMP_CLAUSE_NOTINBRANCH,
  89   PRAGMA_OMP_CLAUSE_NOWAIT,
  90   PRAGMA_OMP_CLAUSE_NUM_TEAMS,
  91   PRAGMA_OMP_CLAUSE_NUM_THREADS,
  92   PRAGMA_OMP_CLAUSE_ORDERED,
  93   PRAGMA_OMP_CLAUSE_PARALLEL,
  94   PRAGMA_OMP_CLAUSE_PRIVATE,
  95   PRAGMA_OMP_CLAUSE_PROC_BIND,
  96   PRAGMA_OMP_CLAUSE_REDUCTION,
  97   PRAGMA_OMP_CLAUSE_SAFELEN,
  98   PRAGMA_OMP_CLAUSE_SCHEDULE,
  99   PRAGMA_OMP_CLAUSE_SECTIONS,
 100   PRAGMA_OMP_CLAUSE_SHARED,
 101   PRAGMA_OMP_CLAUSE_SIMDLEN,
 102   PRAGMA_OMP_CLAUSE_TASKGROUP,
 103   PRAGMA_OMP_CLAUSE_THREAD_LIMIT,
 104   PRAGMA_OMP_CLAUSE_TO,
 105   PRAGMA_OMP_CLAUSE_UNIFORM,
 106   PRAGMA_OMP_CLAUSE_UNTIED
 107 } pragma_omp_clause;
 108
 109 /* All Cilk Plus #pragma omp clauses.  */
 110 typedef enum pragma_cilk_clause {
 111   PRAGMA_CILK_CLAUSE_NONE = 0,
 112   PRAGMA_CILK_CLAUSE_VECTORLENGTH,
 113   PRAGMA_CILK_CLAUSE_LINEAR,
 114   PRAGMA_CILK_CLAUSE_PRIVATE,
 115   PRAGMA_CILK_CLAUSE_FIRSTPRIVATE,
 116   PRAGMA_CILK_CLAUSE_LASTPRIVATE,
 117   PRAGMA_CILK_CLAUSE_REDUCTION
 118 } pragma_cilk_clause;
 119
 120 extern struct cpp_reader* parse_in;
 121
 122 /* It's safe to always leave visibility pragma enabled as if
 123    visibility is not supported on the host OS platform the
 124    statements are ignored.  */
 125 extern void push_visibility (const char *, int);
 126 extern bool pop_visibility (int);
 127
 128 extern void init_pragma (void);
 129
 130 /* Front-end wrappers for pragma registration.  */
 131 typedef void (*pragma_handler_1arg)(struct cpp_reader *);
 132 /* A second pragma handler, which adds a void * argument allowing to pass extra
 133    data to the handler.  */
 134 typedef void (*pragma_handler_2arg)(struct cpp_reader *, void *);
 135
 136 /* This union allows to abstract the different handlers.  */
 137 union gen_pragma_handler {
 138   pragma_handler_1arg handler_1arg;
 139   pragma_handler_2arg handler_2arg;
 140 };
 141 /* Internally used to keep the data of the handler.  */
 142 struct internal_pragma_handler_d {
 143   union gen_pragma_handler handler;
 144   /* Permits to know if handler is a pragma_handler_1arg (extra_data is false)
 145      or a pragma_handler_2arg (extra_data is true).  */
 146   bool extra_data;
 147   /* A data field which can be used when extra_data is true.  */
 148   void * data;
 149 };
 150 typedef struct internal_pragma_handler_d internal_pragma_handler;
 151
 152 extern void c_register_pragma (const char *space, const char *name,
 153                                pragma_handler_1arg handler);
 154 extern void c_register_pragma_with_data (const char *space, const char *name,
 155                                          pragma_handler_2arg handler,
 156                                          void *data);
 157
 158 extern void c_register_pragma_with_expansion (const char *space,
 159                                               const char *name,
 160                                               pragma_handler_1arg handler);
 161 extern void c_register_pragma_with_expansion_and_data (const char *space,
 162                                                        const char *name,
 163                                                    pragma_handler_2arg handler,
 164                                                        void *data);
 165 extern void c_invoke_pragma_handler (unsigned int);
 166
 167 extern void maybe_apply_pragma_weak (tree);
 168 extern void maybe_apply_pending_pragma_weaks (void);
 169 extern tree maybe_apply_renaming_pragma (tree, tree);
 170 extern void add_to_renaming_pragma_list (tree, tree);
 171
 172 extern enum cpp_ttype pragma_lex (tree *);
 173
 174 /* Flags for use with c_lex_with_flags.  The values here were picked
 175    so that 0 means to translate and join strings.  */
 176 #define C_LEX_STRING_NO_TRANSLATE 1 /* Do not lex strings into
 177                                        execution character set.  */
 178 #define C_LEX_STRING_NO_JOIN      2 /* Do not concatenate strings
 179                                        nor translate them into execution
 180                                        character set.  */
 181
 182 /* This is not actually available to pragma parsers.  It's merely a
 183    convenient location to declare this function for c-lex, after
 184    having enum cpp_ttype declared.  */
 185 extern enum cpp_ttype c_lex_with_flags (tree *, location_t *, unsigned char *,
 186                                         int);
 187
 188 extern void c_pp_lookup_pragma (unsigned int, const char **, const char **);
 189
 190 extern GTY(()) tree pragma_extern_prefix;
 191
 192 #endif /* GCC_C_PRAGMA_H */