src/warnings.c

   1 /*
   2 Copyright (C) 2001-2010, Parrot Foundation.
   3 $Id$
   4
   5 =head1 NAME
   6
   7 src/warnings.c - Warning and error reporting
   8
   9 =head1 DESCRIPTION
  10
  11 Parrot C<STRING> and C string versions of a function to print warning/error
  12 messages.
  13
  14 =over 4
  15
  16 =cut
  17
  18 */
  19
  20 #include "parrot/parrot.h"
  21
  22 #include <stdarg.h>
  23
  24 /* HEADERIZER HFILE: include/parrot/warnings.h */
  25
  26 /* HEADERIZER BEGIN: static */
  27 /* Don't modify between HEADERIZER BEGIN / HEADERIZER END.  Your changes will be lost. */
  28
  29 static INTVAL print_warning(PARROT_INTERP, ARGIN_NULLOK(STRING *msg))
  30         __attribute__nonnull__(1);
  31
  32 #define ASSERT_ARGS_print_warning __attribute__unused__ int _ASSERT_ARGS_CHECK = (\
  33        PARROT_ASSERT_ARG(interp))
  34 /* Don't modify between HEADERIZER BEGIN / HEADERIZER END.  Your changes will be lost. */
  35 /* HEADERIZER END: static */
  36
  37 /*
  38
  39 =item C<void print_pbc_location(PARROT_INTERP)>
  40
  41 Prints the bytecode location of the warning or error to C<Parrot_io_STDERR>.
  42
  43 =cut
  44
  45 */
  46
  47 PARROT_EXPORT
  48 void
  49 print_pbc_location(PARROT_INTERP)
  50 {
  51     ASSERT_ARGS(print_pbc_location)
  52     Interp * const tracer = (interp->pdb && interp->pdb->debugger) ?
  53         interp->pdb->debugger :
  54         interp;
  55     Parrot_io_eprintf(tracer, "%Ss\n",
  56             Parrot_Context_infostr(interp, CURRENT_CONTEXT(interp)));
  57 }
  58
  59 /*
  60
  61 =item C<static INTVAL print_warning(PARROT_INTERP, STRING *msg)>
  62
  63 Prints the warning message and the bytecode location.
  64
  65 =cut
  66
  67 */
  68
  69 static INTVAL
  70 print_warning(PARROT_INTERP, ARGIN_NULLOK(STRING *msg))
  71 {
  72     ASSERT_ARGS(print_warning)
  73     if (!msg)
  74         Parrot_io_puts(interp, Parrot_io_STDERR(interp), "Unknown warning\n");
  75     else {
  76         Parrot_io_putps(interp, Parrot_io_STDERR(interp), msg);
  77         if (string_ord(interp, msg, -1) != '\n')
  78             Parrot_io_eprintf(interp, "%c", '\n');
  79     }
  80     print_pbc_location(interp);
  81     return 1;
  82 }
  83
  84 /*
  85
  86 =back
  87
  88 =head2 Parrot Warnings Interface
  89
  90 =over 4
  91
  92 =item C<INTVAL Parrot_warn(PARROT_INTERP, INTVAL warnclass, const char *message,
  93 ...)>
  94
  95 The Parrot C string warning/error reporter.
  96
  97 Returns 2 on error, 1 on success.
  98
  99 C<message, ..> can be a C<Parrot_vsprintf_c()> format with arguments.
 100
 101 =cut
 102
 103 */
 104
 105 PARROT_EXPORT
 106 PARROT_IGNORABLE_RESULT
 107 INTVAL
 108 Parrot_warn(PARROT_INTERP, INTVAL warnclass,
 109             ARGIN(const char *message), ...)
 110 {
 111     ASSERT_ARGS(Parrot_warn)
 112     if (!PARROT_WARNINGS_test(interp, warnclass))
 113         return 2;
 114     else {
 115         STRING *targ;
 116         va_list args;
 117
 118         va_start(args, message);
 119         targ = Parrot_vsprintf_c(interp, message, args);
 120         va_end(args);
 121         return print_warning(interp, targ);
 122     }
 123 }
 124
 125 /*
 126
 127 =item C<void Parrot_warn_deprecated(PARROT_INTERP, const char *message)>
 128
 129 Warn about use of a deprecated feature
 130
 131 C<message> is a C string.
 132
 133 =cut
 134
 135 */
 136
 137 PARROT_EXPORT
 138 void
 139 Parrot_warn_deprecated(PARROT_INTERP, ARGIN(const char *message))
 140 {
 141     ASSERT_ARGS(Parrot_warn_deprecated)
 142
 143     if (PARROT_WARNINGS_test(interp, PARROT_WARNINGS_DEPRECATED_FLAG)) {
 144         STRING *msg = Parrot_sprintf_c(interp, "WARNING: %s\n", message);
 145         print_warning(interp, msg);
 146     }
 147 }
 148
 149 /*
 150
 151 =back
 152
 153 =head1 SEE ALSO
 154
 155 F<include/parrot/warnings.h>.
 156
 157 =cut
 158
 159 */
 160
 161
 162 /*
 163  * Local variables:
 164  *   c-file-style: "parrot"
 165  * End:
 166  * vim: expandtab shiftwidth=4:
 167  */