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
|
//
// srecord - Manipulate EPROM load files
// Copyright (C) 2009, 2010 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
// 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_OUTPUT_FILE_MIF_H
#define SRECORD_OUTPUT_FILE_MIF_H
#include <srecord/output/file.h>
namespace srecord
{
/**
* The srecord::output_file_mif class is used to represent the output state
* of a file in Memory Initialization File (MIF) format (Altera).
*/
class output_file_mif:
public output_file
{
public:
/**
* The destructor.
*/
virtual ~output_file_mif();
private:
/**
* The constructor. It is private on purpose, use the #create
* class method instead.
*
* @param file_name
* The name of the file to be written. The special name "-"
* indicates the standard output is to be used.
*/
output_file_mif(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 written.
*/
static pointer create(const std::string &file_name);
protected:
// See base class for documentation
void write(const record &);
// See base class for documentation
void line_length_set(int);
// See base class for documentation
void address_length_set(int);
// See base class for documentation
int preferred_block_size_get() const;
// See base class for documentation
void command_line(arglex_tool *cmdln);
// See base class for documentation.
const char *format_name() const;
// See base class for documentation.
void notify_upper_bound(unsigned long addr);
private:
/**
* The depth instance variable is used to remember how many bytes
* of data there is. Kind of broken, because we don't know this
* when the header is actually printed.
*/
unsigned long depth;
/**
* The width instance variable is used to remember how many bits
* there are per data item. Default to 8 (traditional bytes).
*/
unsigned width;
/**
* The width_in_bytes instance variable is used to remember how
* many bytes there are per data item. Defaults to 1.
*/
unsigned width_in_bytes;
/**
* The actual_depth instance variable is used to remember how many
* bytes of data there were. This is printed in the footer.
*/
unsigned long actual_depth;
/**
* The header_done instance variable is used to remember whether
* the emit_header method has already been called.
*/
bool header_done;
/**
* The pref_blk_sz instance variable is used to remember the
* preferred block size, in bytes.
*/
int pref_blk_sz;
/**
* The emit_header method is used to emit the file header,
* if necessary.
*/
void emit_header();
/**
* The default constructor. Do not use.
*/
output_file_mif();
/**
* The copy constructor. Do not use.
*/
output_file_mif(const output_file_mif &);
/**
* The assignment operator. Do not use.
*/
output_file_mif &operator=(const output_file_mif &);
};
};
// vim: set ts=8 sw=4 et
#endif // SRECORD_OUTPUT_FILE_MIF_H
|