fendo.addon.projects.fs

.( fendo.addon.projects.fs) cr

\ This file is part of Fendo
\ (http://programandala.net/en.program.fendo.html).

\ This file is the projects addon.  It provides tools to add shared
\ metadata about software projects to the website pages.
\
\ XXX NOT FINISHED

\ Last modified  20220123T1349+0100.
\ See change log at the end of the file.

\ Copyright (C) 2015,2017,2018 Marcos Cruz (programandala.net)

\ Fendo 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 2 of the License, or
\ (at your option) any later version.

\ Fendo 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://gnu.org/licenses>.

\ Fendo is written in Forth (http://forth-standard.org)
\ with Gforth (http://gnu.org/software/gforth).

\ ==============================================================
\ Requirements {{{1

forth_definitions

require galope/package.fs \ `package`, `private`, `public`, `end-package`

fendo_definitions

\ ==============================================================
\ Code {{{1

package fendo.addon.projects

\ ----------------------------------------------
\ First approach, abandoned {{{2

\ A data structure holds the data of named projects,
\ and any page can be associated with a project.

false [if]  \ XXX OLD -- not finished

\ Project structure
0
  2 cells +field >project_status     \ active, paused, halted or abandoned
  2 cells +field >project_start      \ date in ISO format
  2 cells +field >project_end        \ date in ISO format
  2 cells +field >project_completion \ percentage (as a string)
constant /project 

public

datum: project  \ name of the project the page is associated to

: (project_datum) ( +n project -- ca len )
  ;

: pid>project? ( pid -- a true | false )
  ;

: project_datum: ( +n "name"  -- )
  create ,
  does> ( pid -- ca len ) ( pid pfa )
  project dup if  (project_datum)  else  then ;
  \ Create a new project datum.
  \ +n = datum offset from the start of the project data.

0 >project_status       project_datum: project_status
0 >project_start        project_datum: project_start
0 >project_end          project_datum: project_end
0 >project_completion   project_datum: project_completion

variable projects  \ counter

: project: ( "name" -- )
  /project allocate throw constant ;
  \ Create a new project.

[then]

\ ----------------------------------------------
\ Second approach {{{2

\ An ordinary metadatum holds the page ID of the page that has the
\ data of the project (or nothing if the current page has the data).
\ Project metadata are hold in special fields.

datum: project_page

: :project_datum>value ( ca len -- )
  nextname create
    cell /datum dup @ , +!  \ store the offset and increment it
  does> ( a1 | "text<nl>" -- ca1 len1 | ) ( a1 dfa | dfa "text<nl>" )
    @  in_data_header? @ ( u f )
    if  ( u "datum<nl>" ) parse_datum
    else ( a1 u ) + $@  then ;
  \ Create a project page metadatum that returns its value.
  \ This is the normal version of the metadatum: if executed in
  \ the metadata header (between `data{` and `}data`) it will
  \ parse its datum from the input stream; out of the header it
  \ will return the datum string.
  \ ca len = datum name
  \ a1 = page data address
  \ ca1 len1 = datum 
  \ dfa = data field address of the datum word
  \ u = datum offset

: :project_datum>address ( ca len -- )
  s" '" 2swap s+ nextname
  latestxt  \ of the word previously created by `:project_datum>value`
  create ( xt ) >body ,
  does> ( a1 -- a2 ) ( a1 dfa ) @ @
\    dup ." datum offset = " .  \ XXX INFORMER
   ( a1 u ) + ;
  \ Create a project page metadatum word that returns the address of its data.
  \ The new name will have a tick at the start.
  \ ca len = datum name
  \ a1 = page data address
  \ a2 = datum address
  \ dfa = data field address of the datum word
  \ u = datum offset

: project_datum: ( "name" -- )
  \ Create a project page metadatum.
  parse-name 2dup :datum>value :datum>address ;

project_datum: project_status
project_datum: project_start
project_datum: project_end
project_datum: project_completion

\ ==============================================================
\ Calculated data {{{1

: completed_project? ( pid -- f )
  dup project_completion s" 100%" str=
  swap project_status s" completed" str= or ;
  \ Is the project completed?

: ceased_project? ( pid -- f )
  project_end nip 0<> ;
  \ Is the project completed or abandoned?

: abandoned_project? ( pid -- f )
  project_status s" abandoned" str= ;
  \ Is the project abandoned?

: project? ( pid -- f )
  dup >r project_status nip
  r@ project_start nip
  r> project_completion nip  or or ;
  \ Is the given page a project?

end-package

.( fendo.addon.projects.fs compiled) cr

\ ==============================================================
\ Change log {{{1

\ 2015-02-02: Start, partly based on the code of
\ <fendo-programandala.addon.projects.fs>.
\
\ 2015-02-06: Start of a new approach.
\
\ 2015-02-11: Fix: proper `definitions` in the requirements.
\
\ 2017-06-22: Update source style, layout and header.
\
\ 2018-09-27: Use `package` instead of `module:`.
\
\ 2018-12-06: Fix typo.
\
\ 2018-12-08: Update notation of Forth words in comments and strings.
\
\ 2018-12-08: Update notation of page IDs in comments and strings.

\ vim: filetype=gforth