srecord 1.65.0
 
Loading...
Searching...
No Matches
fairchild.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 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_FAIRCHILD_H
21#define SRECORD_OUTPUT_FILE_FAIRCHILD_H
22
23#include <srecord/output/file.h>
24
25namespace srecord
26{
27
28/**
29 * The srecord::output_file_fairchild class is used to represent the running
30 * state when writing a file in Fairchild Fairbug format.
31 */
32class output_file_fairchild:
33 public output_file
34{
35public:
36 /**
37 * The destructor.
38 */
40
41private:
42 /**
43 * The constructor. It is private on purpose, use the create class
44 * method instead.
45 *
46 * @param file_name
47 * The name of the file to be written.
48 */
49 output_file_fairchild(const std::string &file_name);
50
51public:
52 /**
53 * The create class method is used to create new dynamically
54 * allocated instances of this class.
55 *
56 * @param file_name
57 * The name of the file to be written.
58 */
59 static pointer create(const std::string &file_name);
60
61protected:
62 // See base class for documentation.
63 void write(const record &);
64
65 // See base class for documentation.
66 void line_length_set(int);
67
68 // See base class for documentation.
70
71 // See base class for documentation.
73
74 // See base class for documentation.
75 bool preferred_block_size_set(int nbytes);
76
77 // See base class for documentation.
78 const char *format_name() const;
79
80private:
81 /**
82 * The put_nibble method puts a single hex-digit on the output.
83 * We override the one in the base class because the checksum is
84 * nibble-based, not byte-based.
85 */
86 void put_nibble(unsigned);
87
88 /**
89 * The put_byte method puts two hex-digits to the output.
90 * We override the one in the base class because the checksum is
91 * nibble-based, not byte-based.
92 */
93 void put_byte(unsigned char);
94
95 /**
96 * The address instance variable is used to remember the current
97 * memory position within the output.
98 */
99 unsigned long address;
100
101 /**
102 * The default constructor. Do not use.
103 */
104 output_file_fairchild();
105
106 /**
107 * The copy constructor. Do not use.
108 */
109 output_file_fairchild(const output_file_fairchild &);
110
111 /**
112 * The assignment operator. Do not use.
113 */
114 output_file_fairchild &operator=(const output_file_fairchild &);
115};
116
117};
118
119#endif // SRECORD_OUTPUT_FILE_FAIRCHILD_H
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...
void address_length_set(int)
The address_length_set method is used to set the minimum number of bytes to be written for addresses ...
int preferred_block_size_get() const
The preferred_block_size_get method is used to get the proferred block size of the output fformat.
static pointer create(const std::string &file_name)
The create class method is used to create new dynamically allocated instances of this class.
const char * format_name() const
The format_name method is used to obtain the name of this output format.
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...
virtual ~output_file_fairchild()
The destructor.
void write(const record &)
The write method is used to write a recordonto an output.
output_file()
The default constructor.
std::shared_ptr< output > pointer
Definition output.h:41
The srecord::record class is used to represent a data record read from a file.
Definition record.h:35