This documenta- tion describes the current state of development.
Note that interfaces and functionality may still change.

Prokee Modules:
  A
  B
  C
  D
  E
  F
  G
  I
  L
  M
  N
  O
  P
  R
  S
  T
  U
  W

     open all    |    close all

GUI Elements:
  B
  C
  I
  M
  P
  R
  S
  T

     open all    |    close all

GUI Interactions:
  B
  F
  H
  S

     open all    |    close all

GUI Layouts:
  L

     open all    |    close all

Games/Demos:
  M

     open all    |    close all

Third Party Libraries:
  P
  F
  Z

     open all    |    close all

Information about this Website / Informationen zu dieser Webseite:
In case of any questions, or comments, please feel free to contact me via email at apoll500@gmail.com.

Module updiff [Version: v01]

This documentation describes the Prokee module interface.


Static Methods:
diff
int updiff::diff(const char *localpath,const char *outpath)
list
int updiff::list(const char *localpath,const char *outpath)
reset
int updiff::reset(const char *localpath,const char *outpath)
update
int updiff::update(const char *localpath,const char *outpath)
clear
int updiff::clear(const char *outpath)
main
main
int updiff::main(int argc,char **argv)

Motivation


Static Methods

   diff


Copies modified or new files to PATH_B.

There are two paths constructed from outpath:
1) PATH_A = outpath + "online/"
2) PATH_B = outpath + "diff/"

The function tests for every file within localpath (and for all files within sub-directories), if there exists a file with the same name (and within the same sub-directory) at PATH_A). If so, the function compares the contents of both files. If both files are equal, the function ignores this file. In all other cases, the file from localpath is copied to PATH_B or to the same named sub-directories within PATH_B respectively.

Signature:
int updiff::diff(const char *localpath,const char *outpath)

Parameters:
Type Name Direction Description
const char *localpath[IN]Der lokale Pfad.
const char *outpath[IN]Der Ausgabe-Pfad.

Return value:
nicht spezifiziert

   list


Diese Funktion durchläuft alle Dateien unter localpath und prüft für jede Datei, ob eine gleich benannte Datei mit gleichem Inhalt unter outpath/online/ existiert. Ist dies nicht der Fall, so wird der Name der betreffenden Datei (inkl. Pfad) in der Datei outpath/difflist.def (im Abschnitt 'update') eingetragen. Dateien, die unter outpath/online/ existieren, für die aber keine gleichnamige Datei unter localpath vorhanden ist, erfolgt ebenso ein Eintrag in der Datei outpath/difflist.def (im Abschnitt 'delete').

There are two paths constructed from outpath:
1) PATH_A = outpath + "online/"
2) PATH_D = outpath + "difflist.def"

...

Signature:
int updiff::list(const char *localpath,const char *outpath)

Parameters:
Type Name Direction Description
const char *localpath[IN]Der lokale Pfad.
const char *outpath[IN]Der Ausgabe-Pfad.

Return value:
nicht spezifiziert

   reset


Löcht das Verzeichnis outpath und Kopiert anschließend alle Dateien von localpath nach outpath/online/.

Achtung: Diese Funktion ruft clear(outpath) und update(localpath,outpath) auf.

Signature:
int updiff::reset(const char *localpath,const char *outpath)

Parameters:
Type Name Direction Description
const char *localpath[IN]Der lokale Pfad.
const char *outpath[IN]Der Ausgabe-Pfad.

Return value:
nicht spezifiziert

   update


Updates PATH_A.

The following path is constructed from outpath:
PATH_A = outpath + "online/"

The function copies all files (and all sub-directories) from localpath to PATH_A. (Empty folders are ignored.)

Signature:
int updiff::update(const char *localpath,const char *outpath)

Parameters:
Type Name Direction Description
const char *localpath[IN]Der lokale Pfad.
const char *outpath[IN]Der Ausgabe-Pfad.

Return value:
nicht spezifiziert

   clear


This deletes directory outpath and all its contents.

Führt das folgende Kommando aus:
rm -R outpath

Achtung: Diese Funktion löscht das Verzeichnis outpath!

Achtung: Der String in outpath wird als Parameter des rm Kommandos ausgeführt. Prüfen Sie vorher welcher String übergeben wird!

Signature:
int updiff::clear(const char *outpath)

Parameters:
Type Name Direction Description
const char *outpath[IN]Der Ausgabe-Pfad.

Return value:
nicht spezifiziert

   main


Runs updiff.

See Commandline-Interface.

Signature:
int updiff::main(int argc,char **argv)

Parameters:
Type Name Direction Description
int argcThe number of command-line parameters.
char **argv[IN]The command-line parameters.

Return value:
Exit status.


Copyright © 2017 - 2019 by Andreas Pollhammer