src/document.h

/*
 *  LDForge: LDraw parts authoring CAD
 *  Copyright (C) 2013, 2014 Santeri Piippo
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU 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 General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LDFORGE_DOCUMENT_H
#define LDFORGE_DOCUMENT_H

#include "main.h"
#include "ldtypes.h"
#include "history.h"
#include <QObject>

class History;
class OpenProgressDialog;
class LDDocumentPointer;

namespace LDPaths
{
	void initPaths();
	bool tryConfigure (str path);

	str ldconfig();
	str prims();
	str parts();
	str getError();
}

// =============================================================================
// LDDocument
//
// The LDDocument class stores a document opened in LDForge either as a editable
// file for the user or for subfile caching. Its methods handle file input and
// output.
//
// A file is implicit when they are opened automatically for caching purposes
// and are hidden from the user. User-opened files are explicit (not implicit).
//
// The default name is a placeholder, initially suggested name for a file. The
// primitive generator uses this to give initial names to primitives.
// =============================================================================
class LDDocument : public QObject
{
	properties:
		Q_OBJECT
		PROPERTY (private,	QList<LDObject*>,	Objects, 		NO_OPS,		STOCK_WRITE)
		PROPERTY (private,	History*,			History,		NO_OPS,		STOCK_WRITE)
		PROPERTY (private,	QList<LDObject*>,	Vertices,		NO_OPS,		STOCK_WRITE)
		PROPERTY (public,	str,				Name,			STR_OPS,	STOCK_WRITE)
		PROPERTY (public,	str,				FullPath,		STR_OPS,	STOCK_WRITE)
		PROPERTY (public,	str,				DefaultName,	STR_OPS,	STOCK_WRITE)
		PROPERTY (public,	bool,				Implicit,		BOOL_OPS,	STOCK_WRITE)
		PROPERTY (public,	QList<LDObject*>,	Cache,			NO_OPS,		STOCK_WRITE)
		PROPERTY (public,	long,				SavePosition,	NUM_OPS,	STOCK_WRITE)
		PROPERTY (public,	QListWidgetItem*,	ListItem,		NO_OPS,		STOCK_WRITE)

	public:
		LDDocument();
		~LDDocument();

		int addObject (LDObject* obj); // Adds an object to this file at the end of the file.
		void addObjects (const QList<LDObject*> objs);
		void clearSelection();
		void forgetObject (LDObject* obj); // Deletes the given object from the object chain.
		str getDisplayName();
		const QList<LDObject*>& getSelection() const;
		bool hasUnsavedChanges() const; // Does this document.have unsaved changes?
		QList<LDObject*> inlineContents (LDSubfile::InlineFlags flags);
		void insertObj (int pos, LDObject* obj);
		int getObjectCount() const;
		LDObject* getObject (int pos) const;
		bool save (str path = ""); // Saves this file to disk.
		void swapObjects (LDObject* one, LDObject* other);
		bool isSafeToClose(); // Perform safety checks. Do this before closing any files!
		void setObject (int idx, LDObject* obj);
		void addReference (LDDocumentPointer* ptr);
		void removeReference (LDDocumentPointer* ptr);
		int numReferences() const { return m_refs.size(); }

		inline LDDocument& operator<< (LDObject* obj)
		{
			addObject (obj);
			return *this;
		}

		inline void addHistoryStep()
		{
			m_History->addStep();
		}

		inline void undo()
		{
			m_History->undo();
		}

		inline void redo()
		{
			m_History->redo();
		}

		inline void clearHistory()
		{
			m_History->clear();
		}

		inline void addToHistory (AbstractHistoryEntry* entry)
		{
			*m_History << entry;
		}

		static void closeUnused();
		static LDDocument* current();
		static void setCurrent (LDDocument* f);
		static void closeInitialFile();
		static int countExplicitFiles();

		// Turns a full path into a relative path
		static str shortenName (str a);

	protected:
		void addToSelection (LDObject* obj);
		void removeFromSelection (LDObject* obj);
		friend class LDObject;

	private:
		QList<LDObject*>				m_sel;
		QList<LDDocumentPointer*>	m_refs;

		static LDDocument*			m_curdoc;
};

inline LDDocument* getCurrentDocument()
{
	return LDDocument::current();
}

// Close all current loaded files and start off blank.
void newFile();

// Opens the given file as the main file. Everything is closed first.
void openMainFile (str path);

// Finds an OpenFile by name or null if not open
LDDocument* findDocument (str name);

// Opens the given file and parses the LDraw code within. Returns a pointer
// to the opened file or null on error.
LDDocument* openDocument (str path, bool search);

// Opens the given file and returns a pointer to it, potentially looking in /parts and /p
File* openLDrawFile (str relpath, bool subdirs);

// Close all open files, whether user-opened or subfile caches.
void closeAll();

// Parses a string line containing an LDraw object and returns the object parsed.
LDObject* parseLine (str line);

// Retrieves the pointer to the given document by file name. Document is loaded
// from file if necessary. Can return null if neither succeeds.
LDDocument* getDocument (str filename);

// Re-caches all subfiles.
void reloadAllSubfiles();

// Is it safe to close all files?
bool safeToCloseAll();

QList<LDObject*> loadFileContents (File* f, int* numWarnings, bool* ok = null);

extern QList<LDDocument*> g_loadedFiles;

inline const QList<LDObject*>& selection()
{
	return getCurrentDocument()->getSelection();
}

void addRecentFile (str path);
void loadLogoedStuds();
str basename (str path);
str dirname (str path);

extern QList<LDDocument*> g_loadedFiles; // Vector of all currently opened files.

// =============================================================================
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
// =============================================================================
// FileLoader
//
// Loads the given file and parses it to LDObjects using parseLine. It's a
// separate class so as to be able to do the work progressively through the
// event loop, allowing the program to maintain responsivity during loading.
// =============================================================================
class LDFileLoader : public QObject
{
	Q_OBJECT
	PROPERTY (private,	QList<LDObject*>,	Objects,			NO_OPS,		STOCK_WRITE)
	PROPERTY (private,	bool,					Done,				BOOL_OPS,	STOCK_WRITE)
	PROPERTY (private,	int,					Progress,		NUM_OPS,		STOCK_WRITE)
	PROPERTY (private,	bool,					Aborted,			BOOL_OPS,	STOCK_WRITE)
	PROPERTY (public,		QStringList,		Lines,			NO_OPS,		STOCK_WRITE)
	PROPERTY (public,		int*,					Warnings,		NO_OPS,		STOCK_WRITE)
	PROPERTY (public,		bool,					OnForeground,	BOOL_OPS,	STOCK_WRITE)

	public slots:
		void start();
		void abort();

	private:
		OpenProgressDialog* dlg;

	private slots:
		void work (int i);

	signals:
		void progressUpdate (int progress);
		void workDone();
};

#endif // LDFORGE_DOCUMENT_H