srecord: output/file/intel.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
intel.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 1998, 1999, 2001-2003, 2006-2008, 2010, 2011 Peter Miller
4//
5// This program is free software; you can redistribute it and/or modify
6// it under the terms of the GNU Lesser General Public License as published by
7// the Free Software Foundation; either version 3 of the License, or
8// (at your option) any later version.
9//
10// This program is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU Lesser General Public License for more details.
14//
15// You should have received a copy of the GNU Lesser General Public License
16// along with this program. If not, see
17// <http://www.gnu.org/licenses/>.
18//
19
20#ifndef SRECORD_OUTPUT_FILE_INTEL_H
21#define SRECORD_OUTPUT_FILE_INTEL_H
22
23#include <srecord/output/file.h>
24
25namespace srecord
26{
27
28/**
29 * The srecord::output_file_intel class is used to write an EPROM load file
30 * in Intel Hex format.
31 */
32 class output_file_intel:
33 public output_file
34{
35public:
36 /**
37 * The destructor.
38 */
39 virtual ~output_file_intel();
40
41private:
42 /**
43 * The constructor. It is private on purpose, use the #create
44 * class method instead.
45 *
46 * @param file_name
47 * The name of the file to be written. The special name "-"
48 * indicates the standard output is to be used.
49 */
50 output_file_intel(const std::string &file_name);
51
52public:
53 /**
54 * The create class method is used to create new dynamically
55 * allocated instances of this class.
56 *
57 * @param file_name
58 * The name of the file to be written.
59 */
60 static pointer create(const std::string &file_name);
61
62protected:
63 // See base class for documentation.
64 void write(const record &);
65
66 // See base class for documentation.
67 void line_length_set(int);
68
69 // See base class for documentation.
70 void address_length_set(int);
71
72 // See base class for documentation.
73 int preferred_block_size_get(void) const;
74
75 // See base class for documentation.
76 bool preferred_block_size_set(int nbytes);
77
78 // See base class for documentation.
79 const char *format_name(void) const;
80
81private:
82 /**
83 * The write_inner method is used to write a single line to the
84 * output file.
85 */
86 void write_inner(int, unsigned long, const void *, int);
87
88 /**
89 * The address_base instance variable is used to remember the
90 * current position within the output file
91 */
92 unsigned long address_base;
93
94 /**
95 * The pref_block_size instance variable is used to remember the
96 * preferred number of bytes on each line of the output file.
97 */
98 int pref_block_size;
99
100 enum mode_t
101 {
102 mode_linear, // aka i32hex
103 mode_segmented, // aka i16hex
104 mode_i8hex
105 };
106
107 /**
108 * The mode instance variable is used to remember what addressing
109 * mode the file is currently in. If set to "segmented" (via the
110 * address_length_set method) you get 16-bit MCS-86 output (record
111 * type 2, extended segment address record). The default value of
112 * "linear" gets you 32-bit output (record type 4, extended linear
113 * address record).
114 */
115 mode_t mode;
116
117 /**
118 * The default constructor. Do not use.
119 */
120 output_file_intel();
121
122 /**
123 * The copy constructor. Do not use.
124 */
125 output_file_intel(const output_file_intel &);
126
127 /**
128 * The assignment operator. Do not use.
129 */
130 output_file_intel &operator=(const output_file_intel &);
131};
132
133};
134
135#endif // SRECORD_OUTPUT_FILE_INTEL_H
srecord::output_file_intel
The srecord::output_file_intel class is used to write an EPROM load file in Intel Hex format.
Definition intel.h:34
srecord::output_file_intel::~output_file_intel
virtual ~output_file_intel()
The destructor.
srecord::output_file_intel::preferred_block_size_set
bool preferred_block_size_set(int nbytes)
The preferred_block_size_set method is is to set a precific number of bytes for the preferred block s...
srecord::output_file_intel::create
static pointer create(const std::string &file_name)
The create class method is used to create new dynamically allocated instances of this class.
srecord::output_file_intel::line_length_set
void line_length_set(int)
The set_line_length method is used to set the maximum length of an output line, for those formats for...
srecord::output_file_intel::write
void write(const record &)
The write method is used to write a recordonto an output.
srecord::output_file_intel::format_name
const char * format_name(void) const
The format_name method is used to obtain the name of this output format.
srecord::output_file_intel::address_length_set
void address_length_set(int)
The address_length_set method is used to set the minimum number of bytes to be written for addresses ...
srecord::output_file_intel::preferred_block_size_get
int preferred_block_size_get(void) const
The preferred_block_size_get method is used to get the proferred block size of the output fformat.
srecord::output_file::output_file
output_file()
The default constructor.
srecord::output::pointer
std::shared_ptr< output > pointer
Definition output.h:41
srecord::record
The srecord::record class is used to represent a data record read from a file.
Definition record.h:35
srecord
Definition adler16.h:25
file.h