cppipe/src/cppipe.cpp

#include <cstdlib>
#include <cstring>
#include <filesystem>
#include <iostream>
#include <fstream>
#include <string_view>
#include <optional>

#include <unistd.h>
#include <fcntl.h>
#include <sys/mman.h>
#include "commands.hpp"
#include "../config.h"

using namespace std;
namespace fs = std::filesystem;

enum SrcType
{
	C,
	CPP
};

namespace
{

struct MappedFile		// todo: move to utils
{
	// ~MappedFile()
	// {
	// 	munmap(data, len);
	// }
	char* data;
	unsigned len;
};

// process the args until the src file arg is found, return its index
int parse_args_until_src(int argc, char* argv[]);

// find the source file to run, if it doesn't exist, exit program
fs::path find_path_to_src(string_view src_file);

// find the path of the cache for the given src_file path
fs::path get_cache_dir_path(const fs::path& src_file);

// map file in memory with write permissions
MappedFile mapfile_for_writing(const fs::path& file);

// preprocess the src file, compare and overwrite the result to the previous version
// return whether there was a difference
bool preprocess_and_compare();

// only recompile if changes are present
void compile_src_file();

void print_usage();

SrcType find_src_type(string_view path);

const char DEBUG_PREFIX[] = "__DBG";

// Context
fs::path src_file;
SrcType src_type;
fs::path cache_dir;
fs::path preprocessed_file;
fs::path bin;   // cache bins to avoid recompiles

// Options
bool debug = false;
// just compare timestamps of the source and bin, don't preprocess
bool quick = false;
// Just compile, don't run
bool dont_run = false;
vector<const char*> additional_compiler_args;

}

int main(int argc, char* argv[])
{
	int src_arg = parse_args_until_src(argc, argv);

	// Init context
	src_file = find_path_to_src( argv[src_arg] );
	src_type = find_src_type( argv[src_arg] );
	cache_dir = get_cache_dir_path(src_file);

	preprocessed_file = cache_dir / (debug ? DEBUG_PREFIX : "") += src_file.stem()
		+= (src_type == SrcType::C ? ".i" : ".ii");

	bin = cache_dir / (debug ? DEBUG_PREFIX : "") += src_file.filename();

	// Compile the src
	compile_src_file();

	// Run the src file without forking
	if(dont_run)
		return 0;

	Cmd run;
	if(debug)			   // debug it with gdb
	{
		run += "gdb";
		run += "--args";
	}

	run += bin.c_str();
	for(int i = src_arg+1; i < argc; ++i)
		run += argv[i];

	exec(run);
}

namespace
{

int parse_args_until_src(int argc, char* argv[])
{
	if(argc < 2)
	{
		print_usage();
		exit(1);
	}

	int src_arg = 0;
	for(int i = 1; i < argc; ++i)
	{
		string_view arg( argv[i] );
		if( arg ==  "--help" )
		{
			print_usage();
			cout << "Compile and run C/C++ source FILE\n"
				"Pass the ARGUMENT to the compiled binary\n"
				"The binaries are cached and recompiled only if the source or it's headers have changed\n\n"
				"Options:\n"
				"-g debug the binary, asserts are also enabled\n"
				"-q quicker, just compare source and binary time stamps, if included files were updated a recompile WON'T occur!\n"
				"-n don't run, just compile the file without running it\n\n"

				"Any other argument that begins with '-' is passed to the compiler e.g.:\n"
				"    cppipe -O0 file.cpp\n\n"

				"Environment variables:\n"
				"CPPIPEPATH - ':'-separated list of directories to prepend to the FILE search path\n";
			exit(0);
		}
		else if( arg == "-g" )
		{
			debug = true;
		}
		else if( arg == "-q" )
		{
			quick = true;
		}
		else if( arg == "-n" )
		{
			dont_run = true;
		}
		else if( !arg.empty() && arg[0] == '-') // if it's an unknown option pass it to the compiler
		{
			additional_compiler_args.push_back(argv[i]);
		}
		else		// Then treat it as the src_arg
		{
			src_arg = i;
			break;
		}
	}

	if( !src_arg )
	{
		print_usage();
		exit(1);
	}

	return src_arg;
}

fs::path find_path_to_src(string_view src_file)
{
	if(fs::exists(src_file))	// Found relative to CWD
	{
		return src_file;
	}

	// Search files on CPPIPEPATH
	const char* cppipepath_var = getenv("CPPIPEPATH");
	if(cppipepath_var)	// is set
	{
		const string_view cppipepath = cppipepath_var;
		for(size_t begin = 0, end = cppipepath.find(':');
		    end != string::npos;
		    begin = end+1, end = cppipepath.find(':', begin) )
		{
			const fs::path path_entry = cppipepath.substr(begin, end - begin);

			if( fs::path p = path_entry / src_file; fs::exists(p) )
			{
				return p;
			}
		}
	}

	// Couldn't find the src
	cerr << "File: " << src_file << " doesn't exist\n";
	exit(1);
}

fs::path get_cache_dir_path(const fs::path& src_file)
{
	fs::path cache_dir;
	if(char* XDG_CACHE = getenv("XDG_CACHE_HOME"))
	{
		cache_dir = XDG_CACHE;
		cache_dir /= "cppipe";
	}
	else if(char* HOME = getenv("HOME"))
	{
		cache_dir = HOME;
		cache_dir /= ".cache/cppipe";
	}
	else
	{
		cache_dir = "/var/cache/cppipe";
	}
	cache_dir += fs::canonical( src_file ).parent_path();
	fs::create_directories(cache_dir);
	return cache_dir;
}

MappedFile mapfile_for_writing(const fs::path& file)
{
	fd_t fd = open(file.c_str(), O_RDWR);

	MappedFile res;
	res.len = lseek(fd, 0, SEEK_END);
	res.data = (char*)mmap(nullptr, res.len, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);

	if(res.data == (void*)-1)
	{
		cerr << "ERROR: Couldn't map " << file << " for writing\n";
		exit(1);
	}

	close(fd);
	return res;
}

bool preprocess_and_compare()
{
	Cmd preprocess(
		src_type == SrcType::C ? CC : CXX,
		"-E"		// preprocess only
		#ifdef __OpenBSD__
		,"-I/usr/local/include" // not included by default on OpenBSD
		#endif
		);

	// Add preprocessor flags
	if(src_type == SrcType::C)
	{
		preprocess.append_args({ CFLAGS });
	}
	else
	{
		preprocess.append_args({ CXXFLAGS });
		preprocess += "-xc++"; // treat the file as a .cpp
	}

	if(!debug)
		preprocess +=  "-DNDEBUG";

	// Read source from stdin
	preprocess += "-";

	// THIS IS THE RIGHT WAY BUT CURRENTLY PRODUCES A GCC WARNING
	// File to preprocess
	// fd_t src = open(src_file.c_str(), O_RDONLY);

	// If it begins with #! skip the first line
	// char buf[128];
	// int read_count = read(src, &buf, 128);
	// if(read_count > 1 && buf[0] == '#' && buf[1] == '!')
	// {
	// 	int newline = 0;
	// 	while(buf[newline] != '\n') // out of bounds
	// 		++newline;

	// 	lseek(src, newline, SEEK_SET);
	// }
	// else
	// 	lseek(src, 0, SEEK_SET);

	// Start preprocessing, give the source FD to gcc
	// Proc preprocessing = detachRedirOut(preprocess < src);
	// close(preprocessing.in);

	Proc preprocessing = detachRedirInOut(preprocess);

	// File to preprocess
	MappedFile src = mapfile_for_writing(src_file);

	// If it begins with #! skip the first line
	const char* p = src.data;
	if(src.len > 1 && p[0] == '#' && p[1] == '!')
		while(*p != '\n')
			++p;

	write(preprocessing.in, p, src.len - (p - src.data));
	close(preprocessing.in);

	// Result of preprocessing as string
	string new_pp = read_to_end(preprocessing.out);

	if( !wait(preprocessing) )	// preprocessing failed
		exit(1);

	if( fs::exists(preprocessed_file) ) // todo: clean up if else blocks
	{
		if( fs::file_size(preprocessed_file) == new_pp.size() )
		{
			MappedFile old_pp = mapfile_for_writing(preprocessed_file);
			if( !memcmp(old_pp.data, new_pp.data(), old_pp.len) ) // unchanged
			{
				return false;
			}
			else
			{
				memcpy(old_pp.data, &new_pp[0], old_pp.len);
				munmap(old_pp.data, old_pp.len);
				return true;
			}
			// todo
			// munmap(data, len);
		}
		else
		{
			ofstream pp_file(preprocessed_file);
			pp_file << new_pp;
			return true;
		}
	}
	else
	{
		ofstream pp_file(preprocessed_file);
		pp_file << new_pp;
		return true;
	}
}

void compile_src_file()
{
	if(quick)
	{
		error_code ec;
		if(fs::last_write_time(src_file) < fs::last_write_time(bin, ec))
		{
			// Binary is newer then source, don't recompile
			return;
		}
	}

	bool file_changed = preprocess_and_compare();

	// Only compile if the source is newer then the bin
	if(file_changed || !fs::exists(bin))
	{
		Cmd compile(
			src_type == SrcType::C ? CC : CXX,
			preprocessed_file.c_str(),
			"-o", bin.c_str()
			);


		if(src_type == SrcType::C)
			compile.append_args({ CFLAGS });
		else
			compile.append_args({ CXXFLAGS });


		// Remap the debug source file since we compile from stdin
		string debug_remap = "-fdebug-prefix-map=<stdin>=" + src_file.string();
		if(debug)
			compile.append_args({ DEBUG_FLAGS, debug_remap.c_str() });
		else
			compile.append_args({ RELEASE_FLAGS });

		for(const char* arg: additional_compiler_args)
			compile += arg;

		if( !compile() )	 // if failed to compile
		{
			fs::remove(bin);
			exit(1);
		}
	}
}

void print_usage()
{
	cout << "Usage: cppipe [OPTION]... FILE [ARGUMENT]...\n";
}

SrcType find_src_type(const string_view p)
{
	size_t end = p.size() - 1;

	// if(p.size() > 4 && p[end-3] == '.' && p[end-2] == 'c' && p[end-1] == 'p' && p[end] == 'p')
	// {
	// 	src_type = SrcType::CPP
	// }

	if( p.size() > 2 && p[end-1] == '.' && p[end] == 'c' )
	{
		return SrcType::C;
	}
	else			// treat it as cpp
	{
		return SrcType::CPP;
	}
}

}