#include "enrobage.hh"
#include <vector>
#include <list>
#include <set>
#include <string>
#include <ctype.h>
#include <limits.h>
#include <stdlib.h>
#include "compatibility.hh"
#include "sourcefetcher.hh"
#include <errno.h>
#include <climits>

Include dependency graph for enrobage.cpp:

Classes
class	myparser
	A minimalistic parser used to recognize '#include <faust/...>' patterns when copying architecture files. More...

Macros
#define	TRY_OPEN(filename)

#define	DIR_SEPARATOR '/'
	filebasename returns the basename of a path. More...

#define	IS_DIR_SEPARATOR(ch) ((ch) == DIR_SEPARATOR)

Functions
static bool	isBlank (const string &s)
	Returns true is a line is blank (contains only white caracters) More...

static string &	replaceOccurences (string &str, const string &oldstr, const string &newstr)
	Replace every occurrence of oldstr by newstr inside str. More...

static string &	replaceClassName (string &str)
	Used when copying architecture files to replace default mydsp class name with the user specified one. More...

void	streamCopyLicense (istream &src, ostream &dst, const string &exceptiontag)
	Copy or remove license header. More...

bool	isFaustInclude (const string &s, string &fname)
	True if string s match '#include <faust/fname>'. More...

void	inject (ostream &dst, const string fname)

void	streamCopyUntil (istream &src, ostream &dst, const string &until)
	Copy src to dst until specific line. More...

void	streamCopy (istream &src, ostream &dst)
	Copy src to dst. More...

void	streamCopyUntilEnd (istream &src, ostream &dst)
	Copy src to dst until end. More...

ifstream *	open_arch_stream (const char *filename)
	Try to open an architecture file searching in various directories. More...

const char *	strip_start (const char *filename)

bool	check_url (const char *filename)
	Check if an URL exists. More...

static FILE *	fopenat (string &fullpath, const char dir, const char filename)
	Try to open the file '<dir>/<filename>'. More...

static FILE *	fopenat (string &fullpath, const string &dir, const char *filename)
	Try to open the file '<dir>/<filename>'. More...

static FILE *	fopenat (string &fullpath, const string &dir, const char path, const char filename)
	Try to open the file '<dir>/<path>/<filename>'. More...

static bool	isAbsolutePathname (const string &filename)
	Test absolute pathname. More...

static void	buildFullPathname (string &fullpath, const char *filename)
	Build a full pathname of <filename>. More...

FILE *	fopensearch (const char *filename, string &fullpath)
	Try to open the file <filename> searching in various directories. More...

const char *	filebasename (const char *name)
	returns a pointer on the basename part of name More...

string	filedirname (const string &name)
	returns a string containing the dirname of name If no dirname, returns "." More...

Variables
string	gFaustSuperSuperDirectory

string	gFaustSuperDirectory

string	gFaustDirectory

string	gMasterDirectory

string	gClassName

bool	gInlineArchSwitch

list< string >	gImportDirList

set< string >	alreadyIncluded
	Inject file fname into dst ostream if not already done. More...

Macro Definition Documentation

#define DIR_SEPARATOR '/'

filebasename returns the basename of a path.

(adapted by kb from basename.c)

Parameters

[in] The path to parse.

Returns: The last component of the given path.

Definition at line 522 of file enrobage.cpp.

#define IS_DIR_SEPARATOR ( ch ) ((ch) == DIR_SEPARATOR)

Definition at line 534 of file enrobage.cpp.

Referenced by filebasename().

#define TRY_OPEN ( filename )

Value:

ifstream* f = new ifstream();               \
    f->open(filename, ifstream::in);            \
    if (f->is_open()) return f; else delete f;  \

Definition at line 212 of file enrobage.cpp.

Referenced by open_arch_stream().

Function Documentation

static void buildFullPathname	(	string &	fullpath,
		const char *	filename
	)

static

Build a full pathname of <filename>.

Definition at line 412 of file enrobage.cpp.

References FAUST_PATH_MAX, and isAbsolutePathname().

Referenced by fopensearch().

 {
     char old[FAUST_PATH_MAX];
 
     if (isAbsolutePathname(filename)) {
         fullpath = filename;
     } else {
         fullpath = getcwd (old, FAUST_PATH_MAX);
         fullpath += '/';
         fullpath += filename;
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

bool check_url ( const char * filename )

Check if an URL exists.

Returns: true if the URL exist, false otherwise

Definition at line 296 of file enrobage.cpp.

References http_fetch(), and http_strerror().

Referenced by process_cmdline().

 {
     char* fileBuf = 0;
 
     // Tries to open as an URL for a local file
     if (strstr(filename, "file://") != 0) {
         // Tries to open as a regular file after removing 'file://'
         FILE* f = fopen(&filename[7], "r");
         if (f) {
             fclose(f);
             return true;
         } else {
             cerr << "ERROR : cannot open file '" << filename << "' : " <<  strerror(errno) << "; for help type \"faust --help\"" << endl;
             return false;
         }
      
     // Tries to open as a http URL
     } else if (strstr(filename, "http://") != 0) {
         if (http_fetch(filename, &fileBuf) != -1) {
             return true;
         } else {
             cerr << "ERROR : unable to access URL '" << filename << "' : " << http_strerror() << "; for help type \"faust --help\"" << endl;
             return false;
         }
     } else {
         // Otherwise tries to open as a regular file
         FILE* f = fopen(filename, "r");
         if (f) {
             fclose(f);
             return true;
         } else {
             cerr << "ERROR : cannot open file '" << filename << "' : " <<  strerror(errno) << "; for help type \"faust --help\"" << endl;
             return false;
         }
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

const char* filebasename ( const char * name )

returns a pointer on the basename part of name

Definition at line 544 of file enrobage.cpp.

References IS_DIR_SEPARATOR, and name().

Referenced by copyFaustSources(), filedirname(), and printfaustlisting().

 {
 #if defined (HAVE_DOS_BASED_FILE_SYSTEM)
     /* Skip over the disk name in MSDOS pathnames. */
     if (isalpha(name[0]) && name[1] == ':') 
         name += 2;
 #endif
 
     const char* base;
     for (base = name; *name; name++)
     {
         if (IS_DIR_SEPARATOR (*name))
         {
             base = name + 1;
         }
     }
     return base;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

string filedirname ( const string & name )

returns a string containing the dirname of name If no dirname, returns "."

Definition at line 568 of file enrobage.cpp.

References filebasename().

Referenced by initFaustDirectories().

 {
     const char*         base = filebasename(name.c_str());
     const unsigned int  size = (const unsigned int)(base-name.c_str());
     string              dirname;
 
     if (size==0) {
         dirname += '.';
 
     } else if (size==1) {
         dirname += name[0];
 
     } else {
         for (unsigned int i=0; i<size-1; i++) {
             dirname += name[i];
         }
     }
     return dirname;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

static FILE* fopenat	(	string &	fullpath,
		const char *	dir,
		const char *	filename
	)

static

Try to open the file '<dir>/<filename>'.

If it succeed, it stores the full pathname of the file into <fullpath>

Definition at line 337 of file enrobage.cpp.

References FAUST_PATH_MAX.

Referenced by fopenat(), and fopensearch().

 {
     int err; 
     char olddirbuffer[FAUST_PATH_MAX];
     char newdirbuffer[FAUST_PATH_MAX];
     
     char* olddir = getcwd (olddirbuffer, FAUST_PATH_MAX);
 
     if (chdir(dir) == 0) {           
         FILE* f = fopen(filename, "r");
         fullpath = getcwd (newdirbuffer, FAUST_PATH_MAX);
         fullpath += '/';
         fullpath += filename;
         err = chdir(olddir);
         return f;
     }
     err = chdir(olddir);
     return 0;
 }

Here is the caller graph for this function:

static FILE* fopenat	(	string &	fullpath,
		const string &	dir,
		const char *	filename
	)

static

Try to open the file '<dir>/<filename>'.

If it succeed, it stores the full pathname of the file into <fullpath>

Definition at line 362 of file enrobage.cpp.

References fopenat().

 {
     return fopenat(fullpath, dir.c_str(), filename);
 }

Here is the call graph for this function:

static FILE* fopenat	(	string &	fullpath,
		const string &	dir,
		const char *	path,
		const char *	filename
	)

static

Try to open the file '<dir>/<path>/<filename>'.

If it succeed, it stores the full pathname of the file into <fullpath>

Definition at line 371 of file enrobage.cpp.

References FAUST_PATH_MAX.

 {
     int err;
     char olddirbuffer[FAUST_PATH_MAX];
     char newdirbuffer[FAUST_PATH_MAX];
     
     char* olddir = getcwd (olddirbuffer, FAUST_PATH_MAX);
     
     if (chdir(dir.c_str()) == 0) {
         if (chdir(path) == 0) {            
             FILE* f = fopen(filename, "r");
             fullpath = getcwd (newdirbuffer, FAUST_PATH_MAX);
             fullpath += '/';
             fullpath += filename;
             err = chdir(olddir);
             return f;
         }
     }
     err = chdir(olddir);
     return 0;
 }

FILE* fopensearch	(	const char *	filename,
		string &	fullpath
	)

Try to open the file <filename> searching in various directories.

If succesful place its full pathname in the string <fullpath>

Definition at line 458 of file enrobage.cpp.

References buildFullPathname(), fopenat(), gFaustDirectory, gFaustSuperDirectory, gFaustSuperSuperDirectory, gImportDirList, and gMasterDirectory.

Referenced by SourceReader::parse().

 {   
     FILE* f;
     char* envpath;
 
 
     // search in current directory
 
     if ((f = fopen(filename, "r"))) { 
         buildFullPathname(fullpath, filename); 
         return f;
     }
 
     // search file in user supplied directory path
 
     for (list< string >::iterator i = gImportDirList.begin(); i != gImportDirList.end(); i++) {
         if ((f = fopenat(fullpath, *i, filename))) {
             //std::cerr << "found file : " << fullpath << std::endl;
             return f;
         }
     }
 
 
     // search in default directories
 
     if ((f = fopenat(fullpath, gMasterDirectory, filename))) { 
         return f;
     }
     if ((envpath = getenv("FAUST_LIB_PATH")) && (f = fopenat(fullpath, envpath, filename))) {
         return f;
     }
     if ((f = fopenat(fullpath, gFaustDirectory, "architecture", filename))) { 
         return f;
     }
     if ((f = fopenat(fullpath, gFaustSuperDirectory, "architecture", filename))) { 
         return f;
     }
     if ((f = fopenat(fullpath, gFaustSuperSuperDirectory, "architecture", filename))) { 
         return f;
     }
 #ifdef INSTALL_PREFIX
     if ((f = fopenat(fullpath, INSTALL_PREFIX "/lib64/faust", filename))) { 
         return f;
     }
 #endif
     if ((f = fopenat(fullpath, "/usr/local/lib64/faust", filename))) { 
         return f;
     }
     if ((f = fopenat(fullpath, "/usr/lib64/faust", filename))) { 
         return f;
     }
     return 0;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void inject	(	ostream &	dst,
		const string	fname
	)

Definition at line 167 of file enrobage.cpp.

References alreadyIncluded, open_arch_stream(), and streamCopy().

Referenced by streamCopyUntil().

 {
     if (alreadyIncluded.find(fname) == alreadyIncluded.end()) {
         alreadyIncluded.insert(fname);
         istream* src = open_arch_stream( fname.c_str());
         if (src) {
             streamCopy(*src, dst);
         } else {
             cerr << "NOT FOUND " << fname << endl;
         }
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

static bool isAbsolutePathname ( const string & filename )

static

Test absolute pathname.

Definition at line 396 of file enrobage.cpp.

Referenced by buildFullPathname().

 {
     //test windows absolute pathname "x:xxxxxx"
     if (filename.size()>1 && filename[1] == ':') return true;
 
     // test unix absolute pathname "/xxxxxx"
     if (filename.size()>0 && filename[0] == '/') return true;
 
     return false;
 }

Here is the caller graph for this function:

static bool isBlank ( const string & s )

static

Returns true is a line is blank (contains only white caracters)

Definition at line 48 of file enrobage.cpp.

Referenced by streamCopyLicense().

                                      {
     for (size_t i=0; i<s.size(); i++) {
         if (s[i] != ' ' && s[i] != '\t') return false;
     }
     return true;
 }

Here is the caller graph for this function:

bool isFaustInclude	(	const string &	s,
		string &	fname
	)

True if string s match '#include <faust/fname>'.

Definition at line 149 of file enrobage.cpp.

References myparser::filename(), myparser::parse(), and myparser::skip().

Referenced by streamCopyUntil().

 {
     myparser P(s);
     if ( P.skip() && P.parse("#include") && P.skip() && P.filename(fname) ) {
         myparser Q(fname);
         return Q.parse("faust/");
     } else {
         return false;
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

ifstream* open_arch_stream ( const char * filename )

Try to open an architecture file searching in various directories.

Definition at line 220 of file enrobage.cpp.

References FAUST_PATH_MAX, gFaustDirectory, gFaustSuperDirectory, gFaustSuperSuperDirectory, and TRY_OPEN.

Referenced by inject(), main(), and openArchFile().

 {
     char    buffer[FAUST_PATH_MAX];
     char*   old = getcwd (buffer, FAUST_PATH_MAX);
     int     err;
 
     TRY_OPEN(filename);
     
     char *envpath = getenv("FAUST_LIB_PATH");
     if (envpath!=NULL) {
         if (chdir(envpath)==0) {
             TRY_OPEN(filename);
         }
     }
     err = chdir(old);
     if ( (chdir(gFaustDirectory.c_str())==0) && (chdir("architecture")==0) ) {
         //cout << "enrobage.cpp : 'architecture' directory found in gFaustDirectory" << endl;
         TRY_OPEN(filename);
     }
     err = chdir(old);
     if ((chdir(gFaustSuperDirectory.c_str())==0) && (chdir("architecture")==0) ) {
         //cout << "enrobage.cpp : 'architecture' directory found in gFaustSuperDirectory" << endl;
         TRY_OPEN(filename);
     }
     err = chdir(old);
     if ((chdir(gFaustSuperSuperDirectory.c_str())==0) && (chdir("architecture")==0) ) {
         //cout << "enrobage.cpp : 'architecture' directory found in gFaustSuperSuperDirectory" << endl;
         TRY_OPEN(filename);
     }
 #ifdef INSTALL_PREFIX
     err = chdir(old);
     if (chdir(INSTALL_PREFIX "/lib64/faust")==0) {
         TRY_OPEN(filename);
     }
     err = chdir(old);
     if (chdir(INSTALL_PREFIX "/include")==0) {
         TRY_OPEN(filename);
     }
 #endif
     err = chdir(old);
     if (chdir("/usr/local/lib64/faust")==0) {
         TRY_OPEN(filename);
     }
     err = chdir(old);
     if (chdir("/usr/lib64/faust")==0) {
         TRY_OPEN(filename);
     }
     err = chdir(old);
     if (chdir("/usr/local/include")==0) {
         TRY_OPEN(filename);
     }
     err = chdir(old);
     if (chdir("/usr/include")==0) {
         TRY_OPEN(filename);
     }
 
     return 0;
 }

Here is the caller graph for this function:

static string& replaceClassName ( string & str )

static

Used when copying architecture files to replace default mydsp class name with the user specified one.

Definition at line 76 of file enrobage.cpp.

References gClassName, and replaceOccurences().

Referenced by streamCopyUntil().

 {
     return replaceOccurences(str, "mydsp", gClassName);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

static string& replaceOccurences	(	string &	str,
		const string &	oldstr,
		const string &	newstr
	)

static

Replace every occurrence of oldstr by newstr inside str.

str is modified and returned as reference for convenience

Definition at line 59 of file enrobage.cpp.

Referenced by replaceClassName().

 {
     string::size_type l1 = oldstr.length();
     string::size_type l2 = newstr.length();
 
     string::size_type pos = str.find(oldstr);
     while (pos != string::npos) {
         str.replace(pos, l1, newstr);
         pos = str.find(oldstr, pos + l2);
     }
     return str;
 }

Here is the caller graph for this function:

void streamCopy	(	istream &	src,
		ostream &	dst
	)

Copy src to dst.

Definition at line 199 of file enrobage.cpp.

References streamCopyUntil().

Referenced by inject(), and main().

 { 
     streamCopyUntil(src, dst, "<<<FOBIDDEN LINE IN A FAUST ARCHITECTURE FILE>>>");
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void streamCopyLicense	(	istream &	src,
		ostream &	dst,
		const string &	exceptiontag
	)

Copy or remove license header.

Architecture files can contain a header specifying the license. If this header contains an exception tag (for example "FAUST COMPILER EXCEPTION") it is an indication for the compiler to remove the license header from the resulting code. A header is the first non blank line that begins a comment.

Definition at line 87 of file enrobage.cpp.

References isBlank().

 {
     string          s;
     vector<string>  H;
 
     // skip blank lines
     while (getline(src,s) && isBlank(s)) dst << s << endl;
 
     // first non blank should start a comment
     if (s.find("/*")==string::npos) { dst << s << endl; return; }
 
     // copy the header into H
     bool remove = false;
     H.push_back(s);
 
     while (getline(src,s) && s.find("*/") == string::npos) {
         H.push_back(s);
         if (s.find(exceptiontag) != string::npos) remove=true;
     }
 
     // copy the header unless explicitely granted to remove it
     if (!remove) {
         // copy the header
         for (unsigned int i=0; i<H.size(); i++) {
             dst << H[i] << endl;
         }
         dst << s << endl;
     }
 }

Here is the call graph for this function:

void streamCopyUntil	(	istream &	src,
		ostream &	dst,
		const string &	until
	)

Copy src to dst until specific line.

Definition at line 183 of file enrobage.cpp.

References gInlineArchSwitch, inject(), isFaustInclude(), and replaceClassName().

Referenced by main(), streamCopy(), and streamCopyUntilEnd().

 {
     string  s;
     string  fname;
     while ( getline(src,s) && (s != until) ) {
         if (gInlineArchSwitch && isFaustInclude(s, fname)) {
             inject(dst, fname);
         } else {
             dst << replaceClassName(s) << endl;
         }
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void streamCopyUntilEnd	(	istream &	src,
		ostream &	dst
	)

Copy src to dst until end.

Definition at line 207 of file enrobage.cpp.

References streamCopyUntil().

Referenced by main().

 { 
     streamCopyUntil(src, dst, "<<<FOBIDDEN LINE IN A FAUST ARCHITECTURE FILE>>>");
 }

Here is the call graph for this function:

Here is the caller graph for this function:

const char* strip_start ( const char * filename )

Definition at line 281 of file enrobage.cpp.

 {
     const char* start = "file://";
     if (strstr(filename, start) != NULL) {
         return &filename[strlen(start)];
     }  else {
         return filename;
     }
 }