git.sur5r.net Git - cc65/blob - src/cc65/output.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 output.h                                  */
   4 /*                                                                           */
   5 /*                           Output file handling                            */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2009-2012, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 52                                           */
  11 /*                D-70794 Filderstadt                                        */
  12 /* EMail:         uz@cc65.org                                                */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef OUTPUT_H
  37 #define OUTPUT_H
  38
  39
  40
  41 #include <stdio.h>
  42
  43 /* common */
  44 #include "attrib.h"
  45
  46
  47
  48 /*****************************************************************************/
  49 /*                                   Data                                    */
  50 /*****************************************************************************/
  51
  52
  53
  54 /* Name of the output file. Dynamically allocated and read only. */
  55 extern const char* OutputFilename;
  56
  57 /* Output file handle. Use WriteOutput if possible. Read only. */
  58 extern FILE* OutputFile;
  59
  60
  61
  62 /*****************************************************************************/
  63 /*                                   Code                                    */
  64 /*****************************************************************************/
  65
  66
  67
  68 void SetOutputName (const char* Name);
  69 /* Sets the name of the output file. */
  70
  71 void MakeDefaultOutputName (const char* InputFilename);
  72 /* If the name of the output file is empty or NULL, the name of the output
  73  * file is derived from the input file by adjusting the file name extension.
  74  */
  75
  76 void OpenOutputFile ();
  77 /* Open the output file. Will call Fatal() in case of failures. */
  78
  79 void OpenDebugOutputFile (const char* Name);
  80 /* Open an output file for debugging purposes. Will call Fatal() in case of
  81  * failures.
  82  */
  83
  84 void CloseOutputFile ();
  85 /* Close the output file. Will call Fatal() in case of failures. */
  86
  87 int WriteOutput (const char* Format, ...) attribute ((format (printf, 1, 2)));
  88 /* Write to the output file using printf like formatting. Returns the number
  89  * of chars written.
  90  */
  91
  92
  93 /* End of output.h */
  94
  95 #endif