Răsfoiți Sursa

Delete a bunch of outdated docs

Daniele Bartolini 13 ani în urmă
părinte
comite
866c4a7eda
3 a modificat fișierele cu 0 adăugiri și 181 ștergeri
  1. BIN
      docs/CodeStyle-1.2.pdf
  2. 0 55
      docs/libreria risorse.txt
  3. 0 126
      docs/path-docs.txt

BIN
docs/CodeStyle-1.2.pdf


+ 0 - 55
docs/libreria risorse.txt

@@ -1,55 +0,0 @@
-#########################
-#   Libreria risorse    #
-#########################
-Un file di libreria contiene un 'file system virtuale' in cui possono essere inseriti file di risorse, organizzati in 
-directory. E' eventualmente possibile comprimere le risorse.
-
-Struttura del file:
-I file e le directory sono rappresentati da delle entry contenute in blocchi di entry (o più semplicemente blocchi).
-Ogni blocco può contenere al massimo MAX_ENTRY_COUNT entry, per rappresentarne di più è possibile concatenare più 
-blocchi tramite l'apposito campo nextBlockOffset.
-In generale non c'è nessun vincolo sulla contiguità dei blocchi, ma è preferibile posizionarli vicini per motivi di eff
-icienza.
-Ogni file di libreria inizia con un header che identifica il tipo e la versione del file.
-Subito dopo l'header è presente un blocco che rappresenta la radice del file system. I blocchi possono contenere indiff
-erentemente file e directory.
-I file hanno dei dati, mentre le directory hanno un delle entry 'figlie'. Per questo, il campo contentOffset nel primo 
-caso indica l'inizio dei dati, mentre nel secondo indica l'offset del blocco di entry figlie.
-
-LibraryHeader
-{
-  uint magicNumber = 0xbabbe000;
-  ushort version;
-}
-
-Block
-{
-	uint nextBlockOffset;
-	uint entriesCount;
-	Descriptor[entriesCount]
-	{
-		uint ID;		//ID univoco
-		ushort type;		//Tipo della risorsa
-		char name[16];		//Nome (massimo 15 caratteri + '\0')
-		uint contentOffset;	//Se è una directory, punta al blocco dei figli, altrimenti ai dati della risorsa
-		uint contentSize;	//Se non è una directory indica la dimensione dei dati
-		uchar compression;	//Compressione, per ora nessuna supportata
-	};
-}
-
----------Tipi risorse----------
-
->Directory
- Nome del tipo: RT_DIRECTORY
- - Sezione dati:
-   non presente
-
->Image
- Nome del tipo: RT_IMAGE
- - Note:
-   E' salvata dall'alto verso il basso.
- - Sezione dati:
-   uint width;
-   uint height;
-   uint pixelFormat;
-   byte imageData[width*height*getBytesPerPixel(pixelFormat)];

+ 0 - 126
docs/path-docs.txt

@@ -1,126 +0,0 @@
-	/**
-		Returns whether the segment is valid.
-	@note
-		The rules for valid segments are as follows:
-		a) The empty string is not valid.
-		b) Any string containing the slash character ('/') is not valid.
-		c) Common notations for current ('.') and parent ('..') directory are forbidden.
-		d) Any string containing segment or device separator characters on the local file system,
-		such as the backslash ('\') and colon (':') on some file systems.
-		(Thanks org.eclipse.core.runtime for the documentation ;D).
-	@param segment
-		The segment to be checked
-	@return
-		True if the segment is valid, false otherwise
-	*/
-	static bool IsValidSegment(const Str& segment);
-
-	/**
-		Returns whether the path is valid.
-	@note
-		The rules for valid paths are as follows:
-		a) The empty string is not valid.
-		b) If the path is absolute, it mustn't contain any leading character.
-	@param path
-		The path to be checked
-	@return
-		True if the path is valid, false otherwise
-	*/
-	static bool IsValidPath(const Str& path);
-
-	/**
-		Fills 'ret' with the same path but without the trailing directory separator.
-	@note
-		(e.g. /home/babbeo/texture.tga/ -> /home/babbeo/texture.tga).
-	@param path
-		The input path
-	@param ret
-		The ouput path
-	@return
-		True if success, false otherwise
-	*/
-	static bool RemoveTrailingSeparator(const Str& path, Str& ret);
-
-	/**
-		Returns whether the path is absolute.
-	@note
-		(i.e. starts with Path::SEPARATOR or <a-Z><Path::DEVICE_SEPARATOR><Path::SEPARATOR>).
-	@param path
-		The path to be checked
-	@return
-		True if absolute, false otherwise
-	*/
-	static bool IsAbsolutePath(const Str& path);
-
-	/**
-		Returns whether the path is a root path.
-	@note
-		(i.e. starts and ends with Path::SEPARATOR or <a-Z><Path::DEVICE_SEPARATOR><Path::SEPARATOR>).
-	@param path
-		The path to be checked
-	@return
-		True if root, false otherwise
-	*/
-	static bool IsRootPath(const Str& path);
-
-	/**
-		Returns the pathname of the path.
-	@note
-		(e.g. /home/babbeo/texture.tga -> /home/babbeo).
-	@param path
-		The input path
-	@param ret
-		The output pathname
-	@return
-		True if success, false otherwise
-	*/
-	static bool GetPathname(const Str& path, Str& ret);
-
-	/**
-		Returns the filename of the path.
-	@note
-		(e.g. /home/babbeo/texture.tga -> texture.tga).
-	@param path
-		The input path
-	@param ret
-		The output filename
-	@return
-		True if success, false otherwise
-	*/
-	static bool GetFilename(const Str& path, Str& ret);
-
-	/**
-		Returns the basename of the path.
-	@note
-		(e.g. /home/babbeo/texture.tga -> texture).
-	@param path
-		The input path
-	@param ret
-		The output basename
-	@return
-		True if success, false otherwise
-	*/
-	static bool GetBasename(const Str& path, Str& ret);
-
-	/**
-		Returns the extension of the path.
-	@note
-		(e.g. /home/babbeo/texture.tga -> tga).
-	@param path
-		The input path
-	@param ret
-		The output extension
-	@return
-		True if success, false otherwise
-	*/
-	static bool GetFileExtension(const Str& path, Str& ret);
-
-	/**
-		Returns the segments contained in path.
-	@param path
-		The input path
-	@param ret
-		The output list containing path's segments
-	@return
-		True if success, false otherwise
-	*/