[Oorexx-svn] SF.net SVN: oorexx:[6794] sandbox/jlf/samples/generator/pipe_readme.txt

[<jfa...@us...>]

Revision: 6794
          http://oorexx.svn.sourceforge.net/oorexx/?rev=6794&view=rev
Author:   jfaucher
Date:     2011-02-22 19:03:04 +0000 (Tue, 22 Feb 2011)

Log Message:
-----------
(re)discovered the Pipe Stages implemented in pipe.rex
This file is a minimal documentation, Pipelines deserve a better documentation (I will do it).
They bring me several ideas for my current work on coroutines.

Added Paths:
-----------
    sandbox/jlf/samples/generator/pipe_readme.txt

Added: sandbox/jlf/samples/generator/pipe_readme.txt
===================================================================
--- sandbox/jlf/samples/generator/pipe_readme.txt	                        (rev 0)
+++ sandbox/jlf/samples/generator/pipe_readme.txt	2011-02-22 19:03:04 UTC (rev 6794)
@@ -0,0 +1,86 @@
+=========================================
+Possible integration in oorexxshell
+=========================================
+
+Currently the input line is assumed to be in totality either ooRexx syntax or 'address' syntax (cmd, bash, hostemu, 'the')
+A command line can start with an interpreter name (oorexx, cmd, bash) and the rest of the line will be processed by the corresponding interpreter.
+If the input line can be splitted in different syntaxes, then the following command line becomes possible :
+    cmd[dir *.exe] | lineCount
+Here, cmd[...] is both a syntax annotation and a pipeStage
+If the stdout of the command is sent to a Rexx queue then it should be possible to make it enter in a pipeline.
+
+
+=========================================
+Notes about pipes
+=========================================
+
+dropLast : eof doesn't forward class(super)
+takeLast : idem
+
+fanout : forward oef to self~next and self~secondary, but not to super
+
+merge : send a 'done' message
+
+displayer : process does forward class (super) --> why needed here, and not in other classes ?
+
+
+http://freshmeat.net/projects/pv
+pv (Pipe Viewer) is a terminal-based tool for monitoring the progress of data through a pipeline. 
+It can be inserted into any normal pipeline between two processes to give a visual indication of 
+how quickly data is passing through, how long it has taken, how near to completion it is, and an 
+estimate of how long it will be until completion.
+
+
+http://www.softpanorama.org/Scripting/Shellorama/Control_structures/pipes_in_loops.shtml
+
+
+=========================================
+Documentation
+=========================================
+
+
+Connectors
+::method '|' class                          -- concatenate an instance of a pipeStage with following pipeStage 'primary follower)
+::method '>' class                          -- concatenate an instance of a pipeStage with following pipeStage (same as '|')
+::method '>>' class                         -- concatenate an instance of a pipeStage with following pipeStage (secondary follower)
+
+
+pipeStage
+    SecondaryConnector(pipeStage)
+    sort                                    -- primary (accumulator)
+    sortWith(comparator)                    -- primary (accumulator)
+    reverse
+    upper
+    lower
+    changestr(old, new, count = 999999999)
+    delstr(offset, length)
+    left(length)                            -- primary, secondary
+    right(length)                           -- primary, secondary
+    insert(insert, offset)
+    overlay(overlay, offset)
+    dropnull
+    dropFirst(count)                        -- primary, secondary
+    dropLast(count)                         -- primary (accumulator), secondary (accumulator)
+    takeFirst(count)                        -- primary, secondary
+    takeLast(count)                         -- primary (accumulator), secondary (accumulator)
+    x2c
+    bitbucket
+    fanout                                  -- primary, secondary. Write records to both outputs streams.
+    merge                                   -- primary, secondary (to investigate : a kind of synchro ?). Merge the results from primary and secondary streams.
+    fanin                                   -- primary(in out), secondary (in accumulator). Process main stream, then secondary stream.
+    duplicate(copies = 1)
+    displayer
+    all(patterns...)                        -- primary, secondary (mismatches)
+    startsWith(match)                       -- primary, secondary (mismatches)
+    notall                                  -- primary, secondary (not selected)
+    stemcollector(stem)                     -- primary (non blocking accumulator)
+    arraycollector(array)                   -- primary (non blocking accumalator)
+    between(startString, endString)         -- primary, secondary (not selected)
+    after(startString)                      -- primary, secondary (while not started)
+    before(endString)                       -- primary, secondary (after started)
+    buffer(count = 1, delimiter = "")       -- primary (accumulator)
+    lineCount
+    charCount
+    wordCount
+    pivot(pivotvalue, next, secondary)      -- primary, secondary. If value < pivotvalue then route to next else route to secondary
+    splitter(stages...)                     -- primary (in). split the processing stream into two or more pipeStages


Property changes on: sandbox/jlf/samples/generator/pipe_readme.txt
___________________________________________________________________
Added: svn:eol-style
   + LF


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.