XPath: replace reflective calls with native functions #2214
Comments
ebruchez
changed the title
|
Scala macro annotations should be able to handle this. You would write something like: @XPathFunction
def runProcessByName(scope: String, name: String): Unit = ...and this would produce: class RunProcessByNameFn extends XFormsFunction with FunctionSupport {
override def iterate(xpathContext: XPathContext): SequenceIterator = {
// 1. Convert function parameters
...
// 2. Call native function
val result = runProcessByName(...)
// 3. Convert and return function result
...
}
}Type conversions, currently done in The functions created this way must also be registered with a function library, with the proper XPath signature: Fun("run-process-by-name", classOf[RunProcessByNameFn], ...)Open questions:
|
|
As a first step, we should place an |
- missing: Form Builder functions - missing: Other functions which won't be used on client - still need to create an actual annotation
- must still go through all FB functions, see #2214
|
[+1 from community] for |
|
Some pointers for Scala macro annotations: |
|
Tasks:
|
|
Updated example of generated code: @XPathFunction
def runProcessByName(scope: String, name: String): Unit = ...
MyLibrary.registerFunction(
// Pass signature
xpathName = "run-process-by-name",
minArity = 2, // needed?
returnType = Type.ITEM_TYPE, EMPTY,
args = List(
Arg(STRING, EXACTLY_ONE),
Arg(STRING, EXACTLY_ONE)
),
constructor = new XFormsFunction with FunctionSupport {
override def iterate(xpathContext: XPathContext): SequenceIterator = {
// 1. Convert function parameters
...
// 2. Call native function
val result = runProcessByName(...)
// 3. Convert and return function result
...
}
}
) |
|
Just hit a bug whereby we incorrectly handle, at runtime, a returned |
|
We now group all Form Builder functions in |
|
The Scala side of this feature falls under the "macro paradise" plugin. As of Scala 2.13, this is still experimental, but it is now part of the compiler (see also release notes). |
|
Q: Do we create one function library per file, or do we have the implementation in the file register the functions to another, external library? The annotation could have parameters if needed: @XPathFunction(ns = "...", lilbrary = ..., xmlName = "...")As a start, make the enclosing class/object explicitly a function library. The macro generates registration code for that. |
|
Classes/objects that expose
|
|
We can also consider explicitly or implicitly passing, depending on the function signature:
For example: @XPathFunction
def foo(
a: String,
b: Option[om.NodeInfo])(implicit
xpc: XPathContext,
xffc: XFormsFunction.Context
): Iterable[om.NodeInfo] = ???In that case, the macro would pass the parameters. |
|
We now have the first simple functions implemented with macros on the offline branch. Missing:
|
|
For a small Form Builder-built form, here are the functions used in the resulting XForms:
We can prioritize those. |
|
If we add the wizard view:
|
|
This is done for the JavaScript runtime, including XForms and Form Runner, on the offline branch.
|
Scala.js doesn't have reflection, so we cannot use direct Java/Scala calls. We could imagine using
JSExportin Scala.js to expose functions, but we won't be able to dynamically know their parameter types, which is needed right now to convert parameters back and forth.There are about 70 functions used by Form Runner. They are gathered below. For reference, I added also the Form Builder functions, which we might want to expose natively on the server too.
Only a subset of those might make sense on the client.
Steps:
Functions in
org.orbeon.oxf.fr.FormRunner:frf:allAuthorizedOperationsAssumingOwnerGroupMemberfrf:authorizedOperationsBasedOnRolesfrf:autosaveSupportedfrf:buildPDFFieldNameFromHTMLfrf:canNavigateNewfrf:canNavigateSummaryfrf:canPublishLocalfrf:canPublishLocalToRemotefrf:canPublishRemotefrf:canPublishRemoteToLocalfrf:canSelectLocalNewerfrf:canSelectPublishedLocalfrf:canSelectPublishedRemotefrf:canSelectRemoteNewerfrf:canSelectUnpublishedLocalfrf:canSelectUnpublishedRemotefrf:canUnpublishLocalfrf:canUnpublishRemotefrf:canUpgradeLocalfrf:canUpgradeRemotefrf:collectDataAttachmentNodesJavafrf:controlNameFromIdfrf:controlNameFromIdOptfrf:controlSortStringfrf:createFormDataBasePathfrf:createFormDefinitionBasePathfrf:createFormMetadataDocumentfrf:currentFormResourcesfrf:duplicatefrf:errorMessagefrf:findRepeatedControlsForTargetfrf:getFormLangSelectionfrf:getPDFFormatExpressionfrf:getPDFFormatsfrf:htmlFieldLabelfrf:hyperlinkURLsfrf:isLocalNewerfrf:isLocalUnavailablefrf:isMultipleSelectionControlfrf:isRemoteAvailablefrf:isRemoteNewerfrf:isRemoteUnavailablefrf:isSingleSelectionControlfrf:isWizardValidatefrf:joinLocalAndRemoteMetadatafrf:orbeonRolesSequencefrf:ownerGroupPermissionsSupportedfrf:pdfFilenameOrNullfrf:publishfrf:remoteServersXPathfrf:resolveTargetRelativeToActionSourcefrf:selectFormLangfrf:selectFormRunnerLangfrf:sendErrorfrf:showCaptchafrf:successMessagefrf:topLevelSectionNameForControlIdfrf:topLevelSectionsWithErrorsfrf:updateIterationfrf:versioningSupportedfrf:xpathAllAuthorizedOperationsFunctions in
org.orbeon.oxf.fr.process.SimpleProcess:process:runProcessprocess:runProcessByNameOther functions:
org.orbeon.oxf.fr.DataMigrationmigration:dataMaybeMigratedFrommigration:dataMaybeMigratedTomigration:findLegacyGridBindsAndTemplates(FB)migration:buildGridMigrationMap(FB)org.orbeon.oxf.util.SecureUtilssecure:randomHexIdorg.orbeon.oxf.util.ScalaUtilsutils:truncateWithEllipsisorg.orbeon.oxf.common.Versionversion:isPEFunctions in
org.orbeon.oxf.fb.FormBuilder(won't be used on client):fbf:MinimalIEVersionfbf:bindIdfbf:bindingForControlElementOrEmptyfbf:buildFormBuilderControlAbsoluteIdOrEmptyfbf:buildFormBuilderControlEffectiveIdOrEmptyfbf:containerByIdfbf:controlNameFromIdfbf:controlsInColfbf:controlsInContainerfbf:controlsInRowfbf:countAllControlsfbf:countAllNonContainersfbf:countGridsfbf:countRepeatsfbf:countSectionTemplatesfbf:countSectionsfbf:currentLangfbf:defaultIterationNamefbf:deleteCellContentfbf:deleteColfbf:deleteGridByIdfbf:deleteRowfbf:deleteSectionByIdfbf:deleteSectionTemplateContentHoldersfbf:expandCellfbf:expandCellTouchesControlfbf:findBindByNameOrEmptyfbf:findBlankLHHAHoldersAndElementsfbf:findControlBoundNodeByNamefbf:findControlByNameOrEmptyfbf:findRepeatIterationNameOrEmptyfbf:findSchemaOrEmptyfbf:findSchemaPrefixOrEmptyfbf:formBuilderPermissionsAsXMLfbf:getAllControlNamesXPathfbf:getBindNameOrEmptyfbf:getContainerNameOrEmptyfbf:getControlHelpOrEmptyfbf:getControlItemsGroupedByValuefbf:getFormDocfbf:getNormalizedMaxOrEmptyfbf:getNormalizedMinfbf:gridCanDoClassesfbf:hasCustomIterationNamefbf:hasEditorfbf:initializeGridsfbf:insertColLeftfbf:insertColRightfbf:insertRowAbovefbf:insertRowBelowfbf:isBrowserSupportedfbf:isContentRepeatfbf:isControlLHHAHTMLMediatypefbf:isLegacyRepeatfbf:isRepeatfbf:iterateSelfAndDescendantBindsResourceHoldersXPathfbf:metadataInstanceRootfbf:moveSectionDownfbf:moveSectionLeftfbf:moveSectionRightfbf:moveSectionUpfbf:nextIdsfbf:possibleAppearancesByControlNameAsXMLfbf:publishfbf:readDefaultAlertAsXMLfbf:readMipAsAttributeOnlyOrEmptyfbf:readValidationsAsXMLfbf:renameControlIfNeededfbf:renameControlIterationIfNeededfbf:resourcesInstanceRootfbf:resourcesRootfbf:sectionCanDoClassesfbf:setControlHelpfbf:setControlItemsfbf:setControlLHHAMediatypefbf:setRepeatPropertiesfbf:shrinkCellfbf:updateMipAsAttributeOnlyfbf:writeAlertsAndValidationsAsXMLOther functions which won't be used on client:
java.util.Maporg.orbeon.oxf.fb.ToolboxOpsorg.orbeon.oxf.fb.MigrationOpsorg.orbeon.oxf.pipeline.api.FunctionLibraryorg.orbeon.oxf.processor.pipeline.PipelineFunctionLibraryorg.orbeon.oxf.util.NetUtilsorg.orbeon.oxf.xml.SaxonUtilsorg.orbeon.oxf.xforms.processor.XFormsResourceServerorg.orbeon.xbl.SimpleCaptchaorg.orbeon.saxon.sxpath.IndependentContextorg.orbeon.saxon.sxpath.XPathEvaluatororg.orbeon.saxon.sxpath.XPathExpressionThe text was updated successfully, but these errors were encountered: