bundles/org.simantics.modeling/scl/Simantics/Rename.scl

   1 import "Simantics/Entity" hiding (findFreshName)\r
   2 \r
   3 importJava "org.simantics.modeling.Rename" where\r
   4     @JavaName renameNode\r
   5     """\r
   6         renameNode resource newName\r
   7         \r
   8     Renames the given `resource` with the given `newName` and returns\r
   9     `string`\r
  10     \r
  11     Example:\r
  12     \r
  13         > renameNode resource "NewName"\r
  14         "Succesfully renamed oldName to NewName"\r
  15         \r
  16     or error if failed\r
  17     """\r
  18     renameNode :: Resource -> String -> <WriteGraph> String\r
  19 \r
  20 """\r
  21     renameMBNode entity newName\r
  22     \r
  23 Renames the given `entity` with the given `newName` and returns\r
  24 `string`\r
  25 \r
  26 Example:\r
  27 \r
  28     > renameMBNode entity "NewName"\r
  29     "Succesfully renamed oldName to NewName"\r
  30     \r
  31 or error if failed\r
  32 """\r
  33 renameMBNode :: Resource -> String -> <WriteGraph> String\r
  34 renameMBNode entity newname = do\r
  35     renameNode (toResource entity) newname\r
  36 \r
  37 importJava "org.simantics.db.common.utils.NameUtils" where\r
  38     @JavaName findFreshName\r
  39     """\r
  40         findFreshName name container\r
  41         \r
  42     Finds fresh and unused name with proposition `name` under the given `container`\r
  43     and returns the freshName\r
  44     \r
  45     Example:\r
  46     \r
  47         freshName = findFreshName "Model" currentProject ()\r
  48     """\r
  49     findFreshName :: String -> Resource -> <ReadGraph> String\r
  50     \r
  51     @JavaName getSafeName\r
  52     """\r
  53         getSafeName resource\r
  54         \r
  55     Gets safe name for the given `resource` and returns the name\r
  56     \r
  57     Example:\r
  58     \r
  59         name = getSafeName (toResource model)\r
  60     """\r
  61     getSafeName :: Resource -> <ReadGraph> String