/* vim: set ts=4 sw=4 tw=99 et:

  *

  * Copyright (C) 2012 David Anderson

  *

  * This file is part of SourcePawn.

  *

  * SourcePawn is free software: you can redistribute it and/or modify it under

  * the terms of the GNU General Public License as published by the Free

  * Software Foundation, either version 3 of the License, or (at your option)

  * any later version.

  * 

  * SourcePawn is distributed in the hope that it will be useful, but WITHOUT ANY

  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

  *

  * You should have received a copy of the GNU General Public License along with

  * SourcePawn. If not, see http://www.gnu.org/licenses/.

  */

 #ifndef _include_jc_structure_h_

 #define _include_jc_structure_h_

 #include "Objects.h"

 #include "Handles.h"

 #include "Vector.h"

 namespace ke {

 class Type;

 class String;

 class FixedArray;

 // When describing composite structures, the GC must be able to trace interior

 // references to Objects. To make this possible, maps that describe composite

 // structures must provide a list of offsets into their objects that are

 // traceable. StructureBufferBuilder assists with this.

 class StructureBufferBuilder

 {

   public:

     StructureBufferBuilder();

     bool add(Handle<Type> type, unsigned *offset);

     unsigned structureSize() const {

         return size_;

     }

     unsigned traceableOffsetCount() const {

         return offsets_.length();

     }

     const unsigned *offsets() {

         return offsets_.buffer();

     }

   private:

     Vector<unsigned> offsets_;

     unsigned size_;

 };

 // Represents a property descriptor for a structure field.

 class Descriptor : public Object

 {

     // The name of the field.

     Barriered<String> name_;

     // The type of the field.

     Barriered<Type> type_;

     // The offset into an object at which this field can be accessed.

     unsigned offset_;

   public:

     static Descriptor *New(Zone *zone, Handle<String> name, Handle<Type> type,

                            unsigned offset);

     String *name() {

         return name_;

     }

     Type *type() {

         return type_;

     }

     unsigned offset() {

         return offset_;

     }

     // Begin GC descriptor.

     static inline size_t offsetOfName() {

         return OFFSETOF(Descriptor, name_);

     }

     static inline size_t offsetOfType() {

         return OFFSETOF(Descriptor, type_);

     }

     // End GC descriptor.

     static inline Descriptor *cast(Object *obj) {

         assert(!obj || obj->is(MapKind_Descriptor));

         return reinterpret_cast<Descriptor *>(obj);

     }

 };

 }

 #endif // _include_jc_structure_h_