[rkward-cvs] [rkward] packages/rkwarddev: cleaning up a bit, make definitions of valid child nodes and modifiers easier to find

Tue Dec 2 15:05:36 UTC 2014

Git commit 81a414f3f49d57e1626fc0d3b8c6b46d3bf5c49c by m.eik michalke.
Committed on 02/12/2014 at 15:04.
Pushed by meikm into branch 'master'.

cleaning up a bit, make definitions of valid child nodes and modifiers easier to find

M  +3    -1    packages/rkwarddev/ChangeLog
A  +36   -0    packages/rkwarddev/R/50_all.valid.children.R
A  +28   -0    packages/rkwarddev/R/50_all.valid.modifiers.R
M  +0    -66   packages/rkwarddev/R/rk-internal.R

http://commits.kde.org/rkward/81a414f3f49d57e1626fc0d3b8c6b46d3bf5c49c

diff --git a/packages/rkwarddev/ChangeLog b/packages/rkwarddev/ChangeLog
index fdb6ceb..8cddce9 100644
--- a/packages/rkwarddev/ChangeLog
+++ b/packages/rkwarddev/ChangeLog
@@ -1,6 +1,6 @@
 ChangeLog for package rkwarddev
 
-changes in version 0.06-6 (2014-12-01)
+changes in version 0.06-6 (2014-12-02)
 fixed:
   - rk.XML.optionset() does now allow to re-use objects defined in the same
     function call (i.e., refer to optioncolumns in the logic section)
@@ -28,6 +28,8 @@ changed:
   - comment nodes (<!-- foo -->) are now globally allowed as child nodes in XML; important for
     i18n comments
   - modifier checks now point to rkwarddev:::all.valid.modifiers directly in case of errors
+  - internally, moved the definitions of valid child nodes and modifiers to separate files, so they're
+    more obvious to find and check
 removed:
   - the functions rk.set.language() rk.get.language() were no longer useful and therefore removed
   - also removed the option "lang" from rk.rkh.doc(), rk.XML.plugin(), rk.XML.pluginmap()
diff --git a/packages/rkwarddev/R/50_all.valid.children.R b/packages/rkwarddev/R/50_all.valid.children.R
new file mode 100644
index 0000000..03ebc98
--- /dev/null
+++ b/packages/rkwarddev/R/50_all.valid.children.R
@@ -0,0 +1,36 @@
+## list with valid child nodes
+# important for certain parent nodes, as long as
+# XiMpLe doesn't interpret doctypes
+# used by -- at least -- valid.child()
+all.valid.children <- list(
+  # 'as' is not a node, but an attribute of <copy>
+  as=c("browser", "checkbox", "column", "copy",
+    "dropdown", "formula", "frame", "input", "page", "radio", "row", "saveobject",
+    "spinbox", "stretch", "tabbook", "text", "valueselector", "valueslot", "varselector", "varslot", "!--"),
+  component=c("dependencies", "!--"),
+  components=c("component", "!--"),
+  context=c("menu", "!--"),
+  dialog=c("browser", "checkbox", "column", "copy",
+    "dropdown", "embed", "formula", "frame", "include", "input", "insert", "matrix",
+    "optionset", "preview", "radio", "row", "saveobject", "spinbox", "stretch", "tabbook",
+    "text", "valueselector", "valueslot", "varselector", "varslot", "!--"),
+  dropdown=c("option", "!--"),
+  hierarchy=c("menu", "!--"),
+  logic=c("connect", "convert", "dependency_check", "external", "include", "insert",
+    "script", "set", "switch", "!--"),
+  menu=c("entry", "menu", "!--"),
+  optionset=c("content", "logic", "optioncolumn", "!--"),
+  page=c("browser", "checkbox", "column", "copy",
+    "dropdown", "formula", "frame", "input", "matrix", "optionset", "page", "radio",
+    "row", "saveobject", "spinbox", "stretch", "tabbook", "text", "valueselector",
+    "valueslot", "varselector", "varslot", "!--"),
+  radio=c("option", "!--"),
+  select=c("option", "!--"),
+  settings=c("setting", "caption", "!--"),
+  snippets=c("include", "snippet", "!--"),
+  valueselector=c("option", "!--"),
+  wizard=c("browser", "checkbox", "column", "copy",
+    "dropdown", "embed", "formula", "frame", "include", "input", "insert", "matrix",
+    "optionset", "page", "preview", "radio", "row", "saveobject", "spinbox", "stretch",
+    "tabbook", "text", "valueselector", "valueslot", "varselector", "varslot", "!--")
+) ## end list with valid child nodes
diff --git a/packages/rkwarddev/R/50_all.valid.modifiers.R b/packages/rkwarddev/R/50_all.valid.modifiers.R
new file mode 100644
index 0000000..acccea6
--- /dev/null
+++ b/packages/rkwarddev/R/50_all.valid.modifiers.R
@@ -0,0 +1,28 @@
+## list with valid modifiers
+# used by -- at least -- modif.validity()
+all.valid.modifiers <- list(
+  all=c("", "visible", "visible.not", "visible.numeric", "enabled", "enabled.not", "enabled.numeric",
+  "required", "true", "false", "not", "numeric", "preprocess", "calculate", "printout", "preview"),
+  browser=c("selection"),
+  checkbox=c("state", "state.not", "state.numeric"),
+  dropdown=c("string", "number"),
+# removed embed, can be all sorts of stuff, see e.g. generic plot options
+#  embed=c("code"),
+# for the same reason external is not listed here
+  frame=c("checked", "checked.not", "checked.numeric"),
+  input=c("text"),
+  formula=c("model", "table", "labels", "fixed_factors", "dependent"),
+  matrix=c("rows", "columns", "tsv", "cbind"), # TODO: missing a solution for 1,2,3,... here
+  option=c("enabled"),
+  optionset=c("row_count", "current_row", "optioncolumn_ids"),
+  preview=c("state", "state.not", "state.numeric"),
+  radio=c("string", "number"),
+  saveobject=c("selection", "parent", "objectname", "active"),
+  select=c("string", "number"),
+  spinbox=c("int", "real"),
+  text=c("text"),
+  valueselector=c("available", "selected", "root"),
+  valueslot=c("available", "selected", "source", "shortname", "label"),
+  varselector=c("selected", "root"),
+  varslot=c("available", "selected", "source", "shortname", "label")
+) ## end list with valid modifiers
diff --git a/packages/rkwarddev/R/rk-internal.R b/packages/rkwarddev/R/rk-internal.R
index b10fa37..e899d95 100644
--- a/packages/rkwarddev/R/rk-internal.R
+++ b/packages/rkwarddev/R/rk-internal.R
@@ -642,35 +642,6 @@ check.ID <- function(node, search.environment=FALSE, env.get="XML"){
 } ## end function check.ID()
 
 
-## list with valid modifiers
-all.valid.modifiers <- list(
-  all=c("", "visible", "visible.not", "visible.numeric", "enabled", "enabled.not", "enabled.numeric",
-  "required", "true", "false", "not", "numeric", "preprocess", "calculate", "printout", "preview"),
-  browser=c("selection"),
-  checkbox=c("state", "state.not", "state.numeric"),
-  dropdown=c("string", "number"),
-# removed embed, can be all sorts of stuff, see e.g. generic plot options
-#  embed=c("code"),
-# for the same reason external is not listed here
-  frame=c("checked", "checked.not", "checked.numeric"),
-  input=c("text"),
-  formula=c("model", "table", "labels", "fixed_factors", "dependent"),
-  matrix=c("rows", "columns", "tsv", "cbind"), # TODO: missing a solution for 1,2,3,... here
-  option=c("enabled"),
-  optionset=c("row_count", "current_row", "optioncolumn_ids"),
-  preview=c("state", "state.not", "state.numeric"),
-  radio=c("string", "number"),
-  saveobject=c("selection", "parent", "objectname", "active"),
-  select=c("string", "number"),
-  spinbox=c("int", "real"),
-  text=c("text"),
-  valueselector=c("available", "selected", "root"),
-  valueslot=c("available", "selected", "source", "shortname", "label"),
-  varselector=c("selected", "root"),
-  varslot=c("available", "selected", "source", "shortname", "label")
-) ## end list with valid modifiers
-
-
 ## function modif.validity()
 # checks if a modifier is valid for an XML node, if source is XiMpLe.node
 # if bool=FALSE, returns the modifier or ""
@@ -732,43 +703,6 @@ modif.validity <- function(source, modifier, ignore.empty=TRUE, warn.only=TRUE,
 } ## end function modif.validity()
 
 
-## list with valid child nodes
-# important for certain parent nodes, as long as
-# XiMpLe doesn't interpret doctypes
-all.valid.children <- list(
-  # 'as' is not a node, but an attribute of <copy>
-  as=c("browser", "checkbox", "column", "copy",
-    "dropdown", "formula", "frame", "input", "page", "radio", "row", "saveobject",
-    "spinbox", "stretch", "tabbook", "text", "valueselector", "valueslot", "varselector", "varslot", "!--"),
-  component=c("dependencies", "!--"),
-  components=c("component", "!--"),
-  context=c("menu", "!--"),
-  dialog=c("browser", "checkbox", "column", "copy",
-    "dropdown", "embed", "formula", "frame", "include", "input", "insert", "matrix",
-    "optionset", "preview", "radio", "row", "saveobject", "spinbox", "stretch", "tabbook",
-    "text", "valueselector", "valueslot", "varselector", "varslot", "!--"),
-  dropdown=c("option", "!--"),
-  hierarchy=c("menu", "!--"),
-  logic=c("connect", "convert", "dependency_check", "external", "include", "insert",
-    "script", "set", "switch", "!--"),
-  menu=c("entry", "menu", "!--"),
-  optionset=c("content", "logic", "optioncolumn", "!--"),
-  page=c("browser", "checkbox", "column", "copy",
-    "dropdown", "formula", "frame", "input", "matrix", "optionset", "page", "radio",
-    "row", "saveobject", "spinbox", "stretch", "tabbook", "text", "valueselector",
-    "valueslot", "varselector", "varslot", "!--"),
-  radio=c("option", "!--"),
-  select=c("option", "!--"),
-  settings=c("setting", "caption", "!--"),
-  snippets=c("include", "snippet", "!--"),
-  valueselector=c("option", "!--"),
-  wizard=c("browser", "checkbox", "column", "copy",
-    "dropdown", "embed", "formula", "frame", "include", "input", "insert", "matrix",
-    "optionset", "page", "preview", "radio", "row", "saveobject", "spinbox", "stretch",
-    "tabbook", "text", "valueselector", "valueslot", "varselector", "varslot", "!--")
-) ## end list with valid child nodes
-
-
 ## function valid.child()
 # - parent: character string, name of the parent node
 # - children: (list of) XiMpLe.node objects, child nodes to check



