#include <LicenseGenerator.hh>

Collaboration diagram for LicenseGenerator:

Public Member Functions
	~LicenseGenerator ()

Static Public Member Functions
static std::string	generateMITLicense (const std::string &year, const std::string &comment)

Private Member Functions
	LicenseGenerator ()=delete

Detailed Description

Definition at line 33 of file LicenseGenerator.hh.

Constructor & Destructor Documentation

◆ ~LicenseGenerator()

LicenseGenerator::~LicenseGenerator ( )

Destructor

Definition at line 34 of file LicenseGenerator.cc.

34{}

◆ LicenseGenerator()

LicenseGenerator::LicenseGenerator ( )

privatedelete

Member Function Documentation

◆ generateMITLicense()

std::string LicenseGenerator::generateMITLicense	(	const std::string &	year,
		const std::string &	comment
	)

static

Generates a MIT license header for a module.

Parameters

year	The copyright year
comment	String used for comment

Returns: The generated MIT license

Definition at line 44 of file LicenseGenerator.cc.

                          {
    std::string license;
    license = 
      comment + " Copyright (c) " + year + " Tampere University.\n"
    + comment + "\n"
    + comment + " Module generated by OpenASIP.\n"
    + comment + "\n"
    + comment + " Permission is hereby granted, free of charge, to any"
    " person obtaining a\n"
    + comment + " copy of this software and associated documentation files"
    " (the \"Software\"),\n"
    + comment + " to deal in the Software without restriction, including"
    " without limitation\n"
    + comment + " the rights to use, copy, modify, merge, publish, "
    "distribute, sublicense,\n"
    + comment + " and/or sell copies of the Software, and to permit "
    "persons to whom the\n"
    + comment + " Software is furnished to do so, subject to the following"
    " conditions:\n"
    + comment + "\n"
    + comment + " The above copyright notice and this permission notice"
    " shall be included in\n"
    + comment + " all copies or substantial portions of the Software.\n"
    + comment + "\n"
    + comment + " THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY" 
    " OF ANY KIND, EXPRESS OR\n"
    + comment + " IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES"
    " OF MERCHANTABILITY,\n"
    + comment + " FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT."
    " IN NO EVENT SHALL THE\n"
    + comment + " AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,"
    " DAMAGES OR OTHER\n"
    + comment + " LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR"
    " OTHERWISE, ARISING\n"
    + comment + " FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR"
    " THE USE OR OTHER\n"
    + comment + " DEALINGS IN THE SOFTWARE.\n\n";
    
    return license;
}

Referenced by ProGe::RV32MicroCodeGenerator::generateMap(), and HDLGenerator::Module::set_header().

The documentation for this class was generated from the following files:

Public Member Functions