srecord: output/file/ti_tagged.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
ti_tagged.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 2000-2003, 2006-2008, 2010 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_TI_TAGGED_H
21#define SRECORD_OUTPUT_FILE_TI_TAGGED_H
22
23#include <srecord/output/file.h>
24
25namespace srecord
26{
27
28/**
29 * The srecord::output_file_ti_tagged class is used to represent the output
30 * state of a file in Texas Instruments Tagged format.
31 */
32 class output_file_ti_tagged:
33 public output_file
34{
35public:
36 /**
37 * The destructor.
38 */
39 virtual ~output_file_ti_tagged();
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_ti_tagged(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() const;
74
75 // See base class for documentation.
76 bool preferred_block_size_set(int nbytes);
77
78 // See base class for documentation.
79 void put_char(int);
80
81 // See base class for documentation.
82 const char *format_name() const;
83
84private:
85 typedef output_file inherited;
86
87 /**
88 * The address instance variable is used to remember the current
89 * address within the output file.
90 */
91 unsigned long address;
92
93 /**
94 * The column instance variable is used to remember the current
95 * text column within the output file. This is so that we can
96 * decide when to throw a new line.
97 */
98 int column;
99
100 /**
101 * The line_length instance variable is used to remember the maximum
102 * permitted text line length. This is so that we can decide when
103 * to throw a new line.
104 */
105 int line_length;
106
107 /**
108 * The csum instance variable is used to remember the 16-bit running
109 * total of the bytes emitted so far. It gets reset by put_eoln.
110 */
111 int csum;
112
113 /**
114 * The put_eoln method is used to output the line termination,
115 * which includes a checksum.
116 */
117 void put_eoln();
118
119 /**
120 * The default constructor. Do not use.
121 */
122 output_file_ti_tagged();
123
124 /**
125 * The copy constructor. Do not use.
126 */
127 output_file_ti_tagged(const output_file_ti_tagged &);
128
129 /**
130 * The assignment operator. Do not use.
131 */
132 output_file_ti_tagged &operator=(const output_file_ti_tagged &);
133};
134
135};
136
137#endif // SRECORD_OUTPUT_FILE_TI_TAGGED_H
srecord::output_file_ti_tagged::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_ti_tagged::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_ti_tagged::format_name
const char * format_name() const
The format_name method is used to obtain the name of this output format.
srecord::output_file_ti_tagged::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_ti_tagged::preferred_block_size_get
int preferred_block_size_get() const
The preferred_block_size_get method is used to get the proferred block size of the output fformat.
srecord::output_file_ti_tagged::~output_file_ti_tagged
virtual ~output_file_ti_tagged()
The destructor.
srecord::output_file_ti_tagged::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_ti_tagged::put_char
void put_char(int)
The put_char method is used to send a character to the output.
srecord::output_file_ti_tagged::write
void write(const record &)
The write method is used to write a recordonto an output.
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