coe.h

Go to the documentation of this file.

//
// srecord - Manipulate EPROM load files
// Copyright (C) 2012 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_COE_H
#define SRECORD_OUTPUT_FILE_COE_H
 
#include <srecord/output/file.h>
 
namespace srecord
{
 
/**
  * The srecord::output_file_coe class is used to represent the output state
  * of a file in Coefficient File Format (Xilinx).
  */
class output_file_coe:
    public output_file
{
public:
    /**
      * The destructor.
      */
    virtual ~output_file_coe();
 
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_coe(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(void) const;
 
    // See base class for documentation.
    bool preferred_block_size_set(int nbytes);
 
    // See base class for documentation
    void command_line(arglex_tool *cmdln);
 
    // See base class for documentation.
    const char *format_name(void) const;
 
    // See base class for documentation.
    void notify_upper_bound(unsigned long addr);
 
private:
    /**
      * The address instance variable is used to remember the next
      * memory address to be written.  This is also used to detect holes
      * in the input data.
      */
    unsigned long address;
 
    /**
      * The column instance variable i sused to remember the output text
      * column.  This is used to know when ti wrap lines.
      */
    int column;
 
    /**
      * 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(void);
 
    /**
      * The GotData instance variable is used to remember whether or not
      * some data has been seen so far.  This is used to separate values
      * with commas, but to suppress the first comma before the first
      * data.
      */
    bool got_data;
 
    /**
      * The default constructor.  Do not use.
      */
    output_file_coe();
 
    /**
      * The copy constructor.  Do not use.
      */
    output_file_coe(const output_file_coe &);
 
    /**
      * The assignment operator.  Do not use.
      */
    output_file_coe &operator=(const output_file_coe &);
};
 
};
 
// vim: set ts=8 sw=4 et :
#endif // SRECORD_OUTPUT_FILE_COE_H