1 /*******************************************************************************
2 * Copyright (c) 2011-2012 Ericsson, Ecole Polytechnique de Montreal and others
4 * All rights reserved. This program and the accompanying materials are made
5 * available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
9 * Contributors: Matthew Khouzam - Initial API and implementation
10 * Contributors: Simon Marchi - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.ctf
.core
.event
.types
;
15 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.event
.io
.BitBuffer
;
20 * A definition is like an object of a declaration class. It fills the declaration
24 * <b>int</b> is the declaration.<br>
25 * <b>i</b> is the definition.<br>
26 * <b>0</b> is the value assigned to the definition, not the declaration.<br>
29 * @author Matthew Khouzam
30 * @author Simon Marchi
32 public abstract class Definition
{
34 // ------------------------------------------------------------------------
36 // ------------------------------------------------------------------------
38 /** The name of the field in its container */
39 protected final String fieldName
;
41 /** The complete path of this field */
42 protected final String path
;
45 * The definition scope in which this definition is found.
47 * The complete path of a definition is thus the path of the definition
48 * scope DOT the name of the definition (name of the field in its container)
50 protected final IDefinitionScope definitionScope
;
52 // ------------------------------------------------------------------------
54 // ------------------------------------------------------------------------
59 * @param definitionScope
60 * the definition is in a scope, (normally a struct) what is it?
62 * the name of the definition. (it is a field in the parent
65 public Definition(IDefinitionScope definitionScope
, String fieldName
) {
66 this.definitionScope
= definitionScope
;
67 this.fieldName
= fieldName
;
68 if (definitionScope
!= null) {
69 String parentPath
= definitionScope
.getPath();
70 if (parentPath
.length() > 0) {
71 path
= parentPath
+ "." + fieldName
; //$NON-NLS-1$
80 * System.out.println("[definition] " + this.getClass().getSimpleName()
81 * + " " + path + " created");
85 // ------------------------------------------------------------------------
87 // ------------------------------------------------------------------------
91 * @return gets the declaration of a datatype
94 public abstract IDeclaration
getDeclaration();
97 * Read the definition from a bitbuffer
100 * the bitbuffer containing the data to read.
102 public abstract void read(BitBuffer input
);
105 public String
toString() {
106 return path
+ '[' + Integer
.toHexString(hashCode()) + ']';