vala/valaflags.vala

   1 /* valaflags.vala
   2  *
   3  * Copyright (C) 2006-2007  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 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 flags declaration in the source code.
  27  */
  28 public class Vala.Flags : DataType {
  29         private List<FlagsValue> values;
  30         private string cname;
  31         private string cprefix;
  32
  33         /**
  34          * Creates a new flags.
  35          *
  36          * @param name   type name
  37          * @param source reference to source code
  38          * @return       newly created flags
  39          */
  40         public Flags (construct string! name, construct SourceReference source_reference = null) {
  41         }
  42
  43         /**
  44          * Appends the specified flags value to the list of values.
  45          *
  46          * @param value a flags value
  47          */
  48         public void add_value (FlagsValue! value) {
  49                 values.append (value);
  50         }
  51
  52         public override void accept (CodeVisitor! visitor) {
  53                 visitor.visit_flags (this);
  54         }
  55
  56         public override void accept_children (CodeVisitor! visitor) {
  57                 foreach (FlagsValue value in values) {
  58                         value.accept (visitor);
  59                 }
  60         }
  61
  62         public override string get_cname (bool const_type = false) {
  63                 if (cname == null) {
  64                         cname = "%s%s".printf (@namespace.get_cprefix (), name);
  65                 }
  66                 return cname;
  67         }
  68
  69         public override string get_upper_case_cname (string infix) {
  70                 return "%s%s".printf (@namespace.get_lower_case_cprefix (), Namespace.camel_case_to_lower_case (name)).up ();
  71         }
  72
  73         public override bool is_reference_type () {
  74                 return false;
  75         }
  76
  77         private void set_cname (string! cname) {
  78                 this.cname = cname;
  79         }
  80
  81         /**
  82          * Returns the string to be prepended to the name of members of this
  83          * enum when used in C code.
  84          *
  85          * @return the prefix to be used in C code
  86          */
  87         public string! get_cprefix () {
  88                 if (cprefix == null) {
  89                         cprefix = "%s_".printf (get_upper_case_cname (null));
  90                 }
  91                 return cprefix;
  92         }
  93
  94         /**
  95          * Sets the string to be prepended to the name of members of this enum
  96          * when used in C code.
  97          *
  98          * @param cprefix the prefix to be used in C code
  99          */
 100         public void set_cprefix (string! cprefix) {
 101                 this.cprefix = cprefix;
 102         }
 103
 104         private void process_ccode_attribute (Attribute! a) {
 105                 if (a.has_argument ("cname")) {
 106                         set_cname (a.get_string ("cname"));
 107                 }
 108                 if (a.has_argument ("cprefix")) {
 109                         set_cprefix (a.get_string ("cprefix"));
 110                 }
 111                 if (a.has_argument ("cheader_filename")) {
 112                         var val = a.get_string ("cheader_filename");
 113                         foreach (string filename in val.split (",")) {
 114                                 add_cheader_filename (filename);
 115                         }
 116                 }
 117         }
 118
 119         /**
 120          * Process all associated attributes.
 121          */
 122         public void process_attributes () {
 123                 foreach (Attribute a in attributes) {
 124                         if (a.name == "CCode") {
 125                                 process_ccode_attribute (a);
 126                         }
 127                 }
 128         }
 129
 130         public override string get_type_id () {
 131                 // FIXME: use GType-registered flags
 132                 return "G_TYPE_INT";
 133         }
 134
 135         public override string get_marshaller_type_name () {
 136                 return "FLAGS";
 137         }
 138
 139         public override string get_get_value_function () {
 140                 return "g_value_get_flags";
 141         }
 142
 143         public override string get_set_value_function () {
 144                 return "g_value_set_flags";
 145         }
 146
 147         public override string get_default_value () {
 148                 return "0";
 149         }
 150 }