3.3. ScriptBasic C API

[<<<] [>>>]

3.3.1. scriba_new()
3.3.2. scriba_destroy()
3.3.3. scriba_NewSbData()
3.3.4. scriba_InitSbData()
3.3.5. scriba_UndefSbData()
3.3.6. scriba_NewSbLong()
3.3.7. scriba_NewSbDouble()
3.3.8. scriba_NewSbUndef()
3.3.9. scriba_NewSbString()
3.3.10. scriba_NewSbBytes()
3.3.11. scriba_DestroySbData()
3.3.12. scriba_PurgeReaderMemory()
3.3.13. scriba_PurgeLexerMemory()
3.3.14. scriba_PurgeSyntaxerMemory()
3.3.15. scriba_PurgeBuilderMemory()
3.3.16. scriba_PurgePreprocessorMemory()
3.3.17. scriba_PurgeExecuteMemory()
3.3.18. scriba_SetFileName()
3.3.19. scriba_GettingConfiguration()
3.3.20. scriba_LoadConfiguration()
3.3.21. scriba_GetConfigFileName()
3.3.22. scriba_InheritConfiguration()
3.3.23. scriba_InitModuleInterface()
3.3.24. scriba_InheritModuleInterface()
3.3.25. scriba_InheritExecuteObject()
3.3.26. scriba_SetProcessSbObject()
3.3.27. scriba_ShutdownMtModules()
3.3.28. scriba_SetCgiFlag()
3.3.29. scriba_SetReportFunction()
3.3.30. scriba_SetReportPointer()
3.3.31. scriba_SetStdin()
3.3.32. scriba_SetStdout()
3.3.33. scriba_SetEmbedPointer()
3.3.34. scriba_SetEnvironment()
3.3.35. scriba_LoadBinaryProgramWithOffset()
3.3.36. scriba_LoadBinaryProgram()
3.3.37. scriba_InheritBinaryProgram()
3.3.38. scriba_LoadInternalPreprocessor()
3.3.39. scriba_ReadSource()
3.3.40. scriba_DoLexicalAnalysis()
3.3.41. scriba_DoSyntaxAnalysis()
3.3.42. scriba_BuildCode()
3.3.43. scriba_IsFileBinaryFormat()
3.3.44. scriba_GetCacheFileName()
3.3.45. scriba_UseCacheFile()
3.3.46. scriba_SaveCacheFile()
3.3.47. scriba_RunExternalPreprocessor()
3.3.48. scriba_SaveCode()
3.3.49. scriba_SaveCCode()
3.3.50. scriba_SaveECode()
3.3.51. scriba_LoadSourceProgram()
3.3.52. scriba_LoadProgramString()
3.3.53. scriba_Run()
3.3.54. scriba_NoRun()
3.3.55. scriba_ResetVariables()
3.3.56. scriba_Call()
3.3.57. scriba_CallArg()
3.3.58. scriba_DestroySbArgs()
3.3.59. scriba_NewSbArgs()
3.3.60. scriba_CallArgEx()
3.3.61. scriba_LookupFunctionByName()
3.3.62. scriba_LookupVariableByName()
3.3.63. scriba_GetVariableType()
3.3.64. scriba_GetVariable()
3.3.65. scriba_SetVariable()
3.3.66. scriba_InitStaticModules()
3.3.67. scriba_FinishStaticModules()

The ScriptBasic C API is the high level programming interface that any programmer wanting to embed ScriptBasic into any application should use. This is the interface that the readily available variations of ScriptBasic use. This interface provides a general, high level abstraction interface to the ScriptBasic compilation and run-time system.

The API provides easy to use, and simple functions that can be used straightforward as well as more sophisticated, complex, harder to understand functions for special purpose application. The programmer can start with the simple functions and use the more complex ones as he or she developer the needs not fulfilled with the simpler functions.

The API delivers an object oriented calling interface even though this API is purely C and not C++. The object oriented interface means that you have to call scriba_new to create a ScriptBasic object before any other call and you have to pass the returned pointer to each called function as first argument to operate on the actual BASIC program object.

This approach allow the programmer to allocate, load, compile, run, re-run, release multiple ScriptBasic programs even in multiple threads simultaneously with the limits that the operating system imposes not ScriptBasic.

[<<<] [>>>]