Blockly Framework Reference

CodeGeneratorService

@objcMembers public final class CodeGeneratorService: NSObject

Service for generating code from a workspace.

For details on how to use this class, see: https://developers.google.com/blockly/guides/configure/ios/code-generators

Closures

• CompletionClosure

  Closure that is called when code has been generated for a request.

  Declaration

  Swift

  public typealias CompletionClosure = (_ requestUUID: String, _ code: String) -> Void

• ErrorClosure

  Closure that is called when an error occurs during a code generation request.

  Declaration

  Swift

  public typealias ErrorClosure = (_ requestUUID: String, _ error: String) -> Void

Initializers

• init(jsCoreDependencies:)

  Creates a code generator service.

  Declaration

  Swift

  public convenience init(jsCoreDependencies: [String])

• init(jsCoreDependencies:bundle:)

  Creates a code generator service.

  Declaration

  Swift

  public init(jsCoreDependencies: [String], bundle: Bundle)

• setRequestBuilder(_:shouldCache:)

  Sets the code generator service request builder to be used for code generation.

  Declaration

  Swift

  public func setRequestBuilder(_ builder: CodeGeneratorServiceRequestBuilder,
      shouldCache: Bool)

• generateCode(forWorkspace:onCompletion:onError:)

  Requests that code be generated from a given workspace.

  Note

  setRequestBuilder(:shouldCache:) must be called prior to calling this method.

  Throws

  BlocklyError: Occurs if no request builder has not been set prior to calling this method or if workspace could not be serialized into XML.

  Declaration

  Swift

  public func generateCode(forWorkspace workspace: Workspace,
                             onCompletion: CompletionClosure? = nil,
                             onError: ErrorClosure? = nil) throws -> String

  Return Value

  A UUID representing this particular request.

• generateCode(forWorkspaceXML:onCompletion:onError:)

  Requests that code be generated from given workspace XML.

  Note

  setRequestBuilder(:shouldCache:) must be called prior to calling this method.

  Throws

  BlocklyError: Occurs if no request builder has not been set prior to calling this method.

  Declaration

  Swift

  public func generateCode(forWorkspaceXML xml: String,
                             onCompletion: CompletionClosure? = nil,
                             onError: ErrorClosure? = nil) throws -> String

  Return Value

  A UUID representing this particular request.

• cancelRequest(uuid:)

  Cancels code generation for a given request.

  Declaration

  Swift

  public func cancelRequest(uuid: String)

• cancelAllRequests()

  Cancels all pending code generation requests.

  Declaration

  Swift

  public func cancelAllRequests()