1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*******************************************************************************
* Copyright (c) 2011, 2013 Ericsson, Ecole Polytechnique de Montreal and others
*
* All rights reserved. This program and the accompanying materials are made
* available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors: Matthew Khouzam - Initial API and implementation
* Contributors: Simon Marchi - Initial API and implementation
*******************************************************************************/
package org.eclipse.linuxtools.ctf.core.event.types;
import org.eclipse.linuxtools.ctf.core.event.io.BitBuffer;
import org.eclipse.linuxtools.ctf.core.event.scope.IDefinitionScope;
import org.eclipse.linuxtools.ctf.core.trace.CTFReaderException;
/**
* A CTF string declaration.
*
* Strings are an array of bytes of variable size and are terminated by a '\0'
* "NULL" character. Their encoding is described in the TSDL meta-data. In
* absence of encoding attribute information, the default encoding is UTF-8.
*
* @version 1.0
* @author Matthew Khouzam
* @author Simon Marchi
*/
public class StringDeclaration extends Declaration {
// ------------------------------------------------------------------------
// Attributes
// ------------------------------------------------------------------------
private final Encoding fEncoding;
// ------------------------------------------------------------------------
// Constructors
// ------------------------------------------------------------------------
/**
* Generate a UTF8 string declaration
*/
public StringDeclaration() {
fEncoding = Encoding.UTF8;
}
/**
* Generate an encoded string declaration
* @param encoding the encoding, utf8 or ascii
*/
public StringDeclaration(Encoding encoding) {
fEncoding = encoding;
}
// ------------------------------------------------------------------------
// Getters/Setters/Predicates
// ------------------------------------------------------------------------
/**
*
* @return the character encoding.
*/
public Encoding getEncoding() {
return fEncoding;
}
@Override
public long getAlignment() {
// See ctf 4.2.5: Strings are always aligned on byte size.
return 8;
}
/**
* @since 3.0
*/
@Override
public int getMaximumSize() {
return Integer.MAX_VALUE;
}
// ------------------------------------------------------------------------
// Operations
// ------------------------------------------------------------------------
/**
* @since 3.0
*/
@Override
public StringDefinition createDefinition(IDefinitionScope definitionScope,
String fieldName, BitBuffer input) throws CTFReaderException {
String value = read(input);
return new StringDefinition(this, definitionScope, fieldName, value);
}
private String read(BitBuffer input) throws CTFReaderException {
/* Offset the buffer position wrt the current alignment */
alignRead(input);
StringBuilder sb = new StringBuilder();
char c = (char) input.get(8, false);
while (c != 0) {
sb.append(c);
c = (char) input.get(8, false);
}
return sb.toString();
}
@Override
public String toString() {
/* Only used for debugging */
return "[declaration] string[" + Integer.toHexString(hashCode()) + ']'; //$NON-NLS-1$
}
}
|
