ccode/valaccodenode.vala

   1 /* valaccodenode.vala
   2  *
   3  * Copyright (C) 2006-2008  Jürg Billeter
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  18  *
  19  * Author:
  20  *      Jürg Billeter <j@bitron.ch>
  21  */
  22
  23 using GLib;
  24
  25 /**
  26  * Represents a node in the C code tree.
  27  */
  28 public abstract class Vala.CCodeNode {
  29         /**
  30          * The source file name and line number to be presumed for this code
  31          * node.
  32          */
  33         public CCodeLineDirective line { get; set; }
  34
  35         /**
  36          * The modifiers for this code node which will be handled as needed
  37          * in every subclass.
  38          */
  39         public CCodeModifiers modifiers { get; set; }
  40
  41         /**
  42          * Writes this code node and all children with the specified C code
  43          * writer.
  44          *
  45          * @param writer a C code writer
  46          */
  47         public abstract void write (CCodeWriter writer);
  48
  49         /**
  50          * Writes declaration for this code node with the specified C code
  51          * writer if necessary.
  52          *
  53          * @param writer a C code writer
  54          */
  55         public virtual void write_declaration (CCodeWriter writer) {
  56         }
  57
  58         /**
  59          * Writes declaration and implementation combined for this code node and
  60          * all children with the specified C code writer.
  61          *
  62          * @param writer a C code writer
  63          */
  64         public virtual void write_combined (CCodeWriter writer) {
  65                 write_declaration (writer);
  66                 write (writer);
  67         }
  68 }