Last update January 25, 2008

Venus Library /
Documentation

Difference (last change) (no other diffs, normal page display)

Changed: 8c8

o.SetValue(value);

o.<n>SetValue?</n>(value);

Changed: 10c10

ObjectSetValue(o,value);

<n>ObjectSetValue?</n>(o,value);

Changed: 15,16c15,16

The initial version 0.01 may not make the idea of LOP fully visible, because quite a number of the functions provided have traditional names. So there is a function Print that should really be called ConsoleWriteType or ConsoleWriteObject but I hadn't the heart to throw this at you (but canonical names will be there soon at least as aliases). Typically LOP makes a lot of sense, because if I write
String s=UrlRetString("http://mydomain.com/index.html");

The initial version 0.01 may not make the idea of LOP fully visible, because quite a number of the functions provided have traditional names. So there is a function Print that should really be called <n>ConsoleWriteType?</n> or <n>ConsoleWriteObject?</n> but I hadn't the heart to throw this at you (but canonical names will be there soon at least as aliases). Typically LOP makes a lot of sense, because if I write
String s=<n>UrlRetString?</n>("<n>

http://mydomain.com/index.html</n>");

Changed: 25,28c25,28

: ObjectAction
: ObjectSetProperty
: ObjectGetProperty
: ObjectRetProperty

: <n>ObjectAction?</n>
: <n>ObjectSetProperty?</n>
: <n>ObjectGetProperty?</n>
: <n>ObjectRetProperty?</n>

Changed: 38,44c38,44

benchmark, benchmark timing, FpBenchPrint DelegateBenchPrint FpRetSec DelegateRetSec
dg, delegate conversion, FpRetDelegate
dirfind, directory searching, DirFindFile DirFindFileCall
print, primitive console output, Print PrintLine
str, string alias functions, StrCat StrCatFmt StrCpy StrCpyFmt
timer, high resolution timer
(the usual Windows QueryPerformance type), TimerRetCount TimerCountRetSec
type, primitive D datatype abstraction, TypeRetTpi

benchmark, benchmark timing, <n>FpBenchPrint? DelegateBenchPrint? FpRetSec? DelegateRetSec?</n>
dg, delegate conversion, <n>FpRetDelegate?</n>
dirfind, directory searching, <n>DirFindFile? DirFindFileCall?</n>
print, primitive console output, Print <n>PrintLine?</n>
str, string alias functions, <n>StrCat? StrCatFmt? StrCpy? StrCpyFmt?</n>
timer, high resolution timer
(the usual Windows <n>QueryPerformance?</n> type), <n>TimerRetCount? TimerCountRetSec?</n>
type, primitive D datatype abstraction, <n>TypeRetTpi?</n>

This is a minimal documentation for the VenusLibrary.

I typically don't describe single functions or methods but only words that constitute the semantics of the interface. The idea of LOP (language oriented programming) is to make the interfaces speak for themselves. That means e. g. that all parameters should be mentioned in the function name in the order they occur and all actions should be described.

I use isomorphic OOP and PP calls, that means an Object

   Object o;

might be used by an object oriented

   o.SetValue(value);

or a procedural

   ObjectSetValue(o,value);

which are considered equivalent (in fact they are technically equivalent because of the implicit this pointer that is passed with the method call).

Typically the Venus library will only use objects when there is a real need for them (typically in OOP everything is made an object).

   String s=UrlRetString("http://mydomain.com/index.html");

then I won't have to tell you lengthy stories about how to use this interface and which objects to create (there are none).

This brings us to Get and Ret:

Get means that the following parameters are output parameters
Ret means that the following parameter is the return value

The typical simple LOP names are:

: ObjectAction
: ObjectSetProperty
: ObjectGetProperty
: ObjectRetProperty

which may be extended, combined and modified (more about this later).

Modules

module	content	main functions
all	central import module	none
benchmark	benchmark timing	FpBenchPrint DelegateBenchPrint FpRetSec DelegateRetSec
dg	delegate conversion	FpRetDelegate
dirfind	directory searching	DirFindFile DirFindFileCall
print	primitive console output	Print PrintLine
str	string alias functions	StrCat StrCatFmt StrCpy StrCpyFmt
timer	high resolution timer (the usual Windows QueryPerformance type)	TimerRetCount TimerCountRetSec
type	primitive D datatype abstraction	TypeRetTpi

Dictionary

word	word type	meaning
Bench	action	do benchmark timing of code
Cat	action	concatenate to String
Cpy	action	copy
Delegate	object	native D delegate (object + method pointer)
Dir	object	file system directory
File	object	file
Find	action	searching in a data structure (slow)
Fp	object	function pointer
Get	action	introduces out parameters relative to the main object
Print	action	output to console
Sec	property	time measured in seconds
Set	action	introduces in parameters relative to the main object
Str	object	alias for char []
Ret	action	the following word specifies the function return value
Timer	object	able to return a counter value
Type	object	abstraction for the D primitive data types

FolderVenus

Venus Library / Documentation

Modules

Dictionary

Venus Library /
Documentation