import "Simantics/Entity" hiding (findFreshName)

importJava "org.simantics.modeling.Rename" where
    @JavaName renameNode
    """
        renameNode resource newName
        
    Renames the given `resource` with the given `newName` and returns
    `string`
    
    Example:
    
        > renameNode resource "NewName"
        "Succesfully renamed oldName to NewName"
        
    or error if failed
    """
    renameNode :: Resource -> String -> <WriteGraph> String

"""
    renameMBNode entity newName
    
Renames the given `entity` with the given `newName` and returns
`string`

Example:

    > renameMBNode entity "NewName"
    "Succesfully renamed oldName to NewName"
    
or error if failed
"""
@deprecated "This function is equivalent to renameNode."
renameMBNode :: Resource -> String -> <WriteGraph> String
renameMBNode entity newname = renameNode entity newname

importJava "org.simantics.db.common.utils.NameUtils" where
    @JavaName findFreshName
    """
        findFreshName name container
        
    Finds fresh and unused name with proposition `name` under the given `container`
    and returns the freshName
    
    Example:
    
        freshName = findFreshName "Model" currentProject ()
    """
    findFreshName :: String -> Resource -> <ReadGraph> String
    
    @JavaName getSafeName
    """
        getSafeName resource
        
    Gets safe name for the given `resource` and returns the name
    
    Example:
    
        name = getSafeName (toResource model)
    """
    getSafeName :: Resource -> <ReadGraph> String