mirror of
				https://github.com/YosysHQ/yosys
				synced 2025-11-04 05:19:11 +00:00 
			
		
		
		
	The option is serialized to RTLIL as `_` (to match Python's option with the same symbol), and sets the `group` flag. This flag inserts an `_` symbol between each group of 3 digits (for decimal) or four digits (for binary, hex, and octal).
		
			
				
	
	
		
			116 lines
		
	
	
	
		
			2.7 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			116 lines
		
	
	
	
		
			2.7 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
/*
 | 
						|
 *  yosys -- Yosys Open SYnthesis Suite
 | 
						|
 *
 | 
						|
 *  Copyright (C) 2020  whitequark <whitequark@whitequark.org>
 | 
						|
 *
 | 
						|
 *  Permission to use, copy, modify, and/or distribute this software for any
 | 
						|
 *  purpose with or without fee is hereby granted, provided that the above
 | 
						|
 *  copyright notice and this permission notice appear in all copies.
 | 
						|
 *
 | 
						|
 *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 | 
						|
 *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 | 
						|
 *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 | 
						|
 *  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 | 
						|
 *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 | 
						|
 *  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 | 
						|
 *  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 | 
						|
 *
 | 
						|
 */
 | 
						|
 | 
						|
#ifndef FMT_H
 | 
						|
#define FMT_H
 | 
						|
 | 
						|
#include "kernel/yosys.h"
 | 
						|
 | 
						|
YOSYS_NAMESPACE_BEGIN
 | 
						|
 | 
						|
// Verilog format argument, such as the arguments in:
 | 
						|
//   $display("foo %d bar %01x", 4'b0, $signed(2'b11))
 | 
						|
struct VerilogFmtArg {
 | 
						|
	enum {
 | 
						|
		STRING  = 0,
 | 
						|
		INTEGER = 1,
 | 
						|
		TIME    = 2,
 | 
						|
	} type;
 | 
						|
 | 
						|
	// All types
 | 
						|
	std::string filename;
 | 
						|
	unsigned first_line;
 | 
						|
 | 
						|
	// STRING type
 | 
						|
	std::string str;
 | 
						|
 | 
						|
	// INTEGER type
 | 
						|
	RTLIL::SigSpec sig;
 | 
						|
	bool signed_ = false;
 | 
						|
 | 
						|
	// TIME type
 | 
						|
	bool realtime = false;
 | 
						|
};
 | 
						|
 | 
						|
// RTLIL format part, such as the substitutions in:
 | 
						|
//   "foo {4:> 4du} bar {2:<01hs}"
 | 
						|
// Must be kept in sync with `struct fmt_part` in backends/cxxrtl/runtime/cxxrtl/cxxrtl.h!
 | 
						|
struct FmtPart {
 | 
						|
	enum {
 | 
						|
		LITERAL  	= 0,
 | 
						|
		INTEGER 	= 1,
 | 
						|
		STRING    = 2,
 | 
						|
		UNICHAR   = 3,
 | 
						|
		VLOG_TIME = 4,
 | 
						|
	} type;
 | 
						|
 | 
						|
	// LITERAL type
 | 
						|
	std::string str;
 | 
						|
 | 
						|
	// INTEGER/STRING/UNICHAR types
 | 
						|
	RTLIL::SigSpec sig;
 | 
						|
 | 
						|
	// INTEGER/STRING/VLOG_TIME types
 | 
						|
	enum {
 | 
						|
		RIGHT	= 0,
 | 
						|
		LEFT	= 1,
 | 
						|
		NUMERIC	= 2,
 | 
						|
	} justify = RIGHT;
 | 
						|
	char padding = '\0';
 | 
						|
	size_t width = 0;
 | 
						|
 | 
						|
	// INTEGER type
 | 
						|
	unsigned base = 10;
 | 
						|
	bool signed_ = false;
 | 
						|
	enum {
 | 
						|
		MINUS		= 0,
 | 
						|
		PLUS_MINUS	= 1,
 | 
						|
		SPACE_MINUS	= 2,
 | 
						|
	} sign = MINUS;
 | 
						|
	bool hex_upper = false;
 | 
						|
	bool show_base = false;
 | 
						|
	bool group = false;
 | 
						|
 | 
						|
	// VLOG_TIME type
 | 
						|
	bool realtime = false;
 | 
						|
};
 | 
						|
 | 
						|
struct Fmt {
 | 
						|
public:
 | 
						|
	std::vector<FmtPart> parts;
 | 
						|
 | 
						|
	void append_literal(const std::string &str);
 | 
						|
 | 
						|
	void parse_rtlil(const RTLIL::Cell *cell);
 | 
						|
	void emit_rtlil(RTLIL::Cell *cell) const;
 | 
						|
 | 
						|
	void parse_verilog(const std::vector<VerilogFmtArg> &args, bool sformat_like, int default_base, RTLIL::IdString task_name, RTLIL::IdString module_name);
 | 
						|
	std::vector<VerilogFmtArg> emit_verilog() const;
 | 
						|
 | 
						|
	void emit_cxxrtl(std::ostream &os, std::string indent, std::function<void(const RTLIL::SigSpec &)> emit_sig, const std::string &context) const;
 | 
						|
 | 
						|
	std::string render() const;
 | 
						|
 | 
						|
private:
 | 
						|
	void apply_verilog_automatic_sizing_and_add(FmtPart &part);
 | 
						|
};
 | 
						|
 | 
						|
YOSYS_NAMESPACE_END
 | 
						|
 | 
						|
#endif
 |