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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
//
// srecord - manipulate eprom load files
// Copyright (C) 2004, 2006-2008, 2010, 2011 Peter Miller
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// This program 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see
// <http://www.gnu.org/licenses/>.
//
#ifndef SRECORD_INPUT_FILE_AOMF_H
#define SRECORD_INPUT_FILE_AOMF_H
#include <srecord/input/file.h>
namespace srecord {
/**
* The srecord::input_file_aomf class is used to parse Intel Absolute Object
* Module Format (AOMF) file.
*/
class input_file_aomf:
public input_file
{
public:
/**
* The destructor.
*/
virtual ~input_file_aomf();
private:
/**
* The constructor. The input is read from the named file (or
* the standard input if the file name is "-"). It is private on
* purpose, use the "create" class method instead.
*
* @param file_name
* The name of the file to be read.
*/
input_file_aomf(const std::string &file_name);
public:
/**
* The create class method is used to create new dynamically
* allocated instances of this class.
*
* @param file_name
* The name of the file to be read.
* @returns
* smart pointer to new instance
*/
static pointer create(const std::string &file_name);
protected:
// See base class for documentation.
bool read(record &record);
// See base class for documentation.
const char *get_file_format_name(void) const;
// See base class for documentation.
bool is_binary(void) const;
// See base class for documentation.
const char *format_option_name(void) const;
private:
/**
* The get_byte method is used to fetch a byte of input, and
* update the checksum. We over-ride the base implementation,
* because we use raw bytes rather than two hex digits.
*/
int get_byte(void);
/**
* The get_word method is used to fetch a 16-bit word of input.
* It calls the #get_byte method twice. We over-ride the base
* implementation, because it uses big-endian and this format
* is little-endian.
*/
int get_word(void);
/**
* The current_buffer instance variable is used to remember the
* base of an array which buffers the current input record.
*/
unsigned char *current_buffer;
/**
* The current_length instance variable is used to remember
* the length of the current record. It is zero if there is no
* "current" record.
*/
size_t current_length;
/**
* The current_maximum instance variable is used to remember the
* length of the current_buffer array. It is zero if there is no
* "current" buffer.
*/
size_t current_maximum;
/**
* The current_pos instance variable is used to remember the
* position within the current_buffer array.
*/
size_t current_pos;
/**
* The current_address instance variable is used to track the
* load address of the current record. It is updated each time
* we return a partial block, so that we alsoways return the
* correct load address.
*/
unsigned long current_address;
enum state_t
{
expecting_header,
expecting_data,
expecting_eof
};
/**
* The state instance variable is used to remember what to expect
* next from the file.
*/
state_t state;
/**
* The slurp method is used to fill the current_buffer array,
* and set the current_length.
*/
int slurp(void);
/**
* The copy constructor. Do not use.
*/
input_file_aomf(const input_file_aomf &);
/**
* The assignment operator. Do not use.
*/
input_file_aomf &operator=(const input_file_aomf &);
};
};
#endif // SRECORD_INPUT_FILE_AOMF_H
|