@dodona/papyros 0.4.2 → 0.5.1

package/dist/CodeRunner.d.ts

@@ -40,9 +40,9 @@ export interface LoadingData {
      */
     modules: Array<string>;
     /**
-     * Whether the modules are being loaded or have been loaded
+     * The status of the import
      */
-    loading: boolean;
+    status: "loading" | "loaded" | "failed";
 }
 /**
  * Helper component to manage and visualize the current RunState
@@ -84,6 +84,10 @@ export declare class CodeRunner extends Renderable<CodeRunnerRenderOptions> {
      * Previous state to restore when loading is done
      */
     private previousState;
+    /**
+     * Time at which the setState call occurred
+     */
+    private runStartTime;
     /**
      * Construct a new RunStateManager with the given listeners
      * @param {ProgrammingLanguage} programmingLanguage The language to use
@@ -104,15 +108,10 @@ export declare class CodeRunner extends Renderable<CodeRunnerRenderOptions> {
      * @param {ProgrammingLanguage} programmingLanguage The language to use
      */
     setProgrammingLanguage(programmingLanguage: ProgrammingLanguage): Promise<void>;
-    getProgrammingLanguage(): ProgrammingLanguage;
     /**
-     * Get the button to run the code
+     * @return {ProgrammingLanguage} The current programming language
      */
-    get runButton(): HTMLButtonElement;
-    /**
-     * Get the button to interrupt the code
-     */
-    get stopButton(): HTMLButtonElement;
+    getProgrammingLanguage(): ProgrammingLanguage;
     /**
      * Show or hide the spinning circle, representing a running animation
      * @param {boolean} show Whether to show the spinner
@@ -124,14 +123,30 @@ export declare class CodeRunner extends Renderable<CodeRunnerRenderOptions> {
      * @param {string} message Optional message to indicate the state
      */
     setState(state: RunState, message?: string): void;
+    /**
+     * @return {RunState} The state of the current run
+     */
     getState(): RunState;
-    removeButton(id: string): void;
+    /**
+     * Remove a button from the internal button list. Requires a re-render to update
+     * @param {string} id Identifier of the button to remove
+     */
+    private removeButton;
     /**
      * Add a button to display to the user
      * @param {ButtonOptions} options Options for rendering the button
      * @param {function} onClick Listener for click events on the button
      */
     addButton(options: ButtonOptions, onClick: () => void): void;
+    /**
+     * Generate a button that the user can click to process code
+     * Can either run the code or interrupt it if already running
+     * @return {DynamicButton} A button to interact with the code according to the current state
+     */
+    private getCodeActionButton;
+    /**
+     * Specific helper method to render only the buttons required by the user
+     */
     private renderButtons;
     protected _render(options: CodeRunnerRenderOptions): HTMLElement;
     /**
@@ -145,5 +160,6 @@ export declare class CodeRunner extends Renderable<CodeRunnerRenderOptions> {
      * @param {BackendEvent} e The loading event
      */
     private onLoad;
+    private onStart;
 }
 export {};

package/dist/InputManager.d.ts

@@ -22,6 +22,7 @@ export declare class InputManager extends Renderable<InputManagerRenderOptions>
     private buildInputHandlerMap;
     getInputMode(): InputMode;
     setInputMode(inputMode: InputMode): void;
+    getInputHandler(inputMode: InputMode): UserInputHandler;
     get inputHandler(): UserInputHandler;
     isWaiting(): boolean;
     protected _render(options: InputManagerRenderOptions): void;

package/dist/editor/BatchInputEditor.d.ts

@@ -1,27 +1,41 @@
 import { CodeMirrorEditor } from "./CodeMirrorEditor";
 import { UsedInputGutterInfo } from "./Gutters";
+import { ViewUpdate } from "@codemirror/view";
 /**
- * Editor to handle and highlight user input
+ * Arguments used to higlight lines in the Editor
  */
-export declare class BatchInputEditor extends CodeMirrorEditor {
+interface HighlightArgs {
     /**
-     * Style classes used to highlight lines
+     * Whether the user's code is currently running and using input
      */
-    private static HIGHLIGHT_CLASSES;
+    running: boolean;
+    /**
+     * Function to obtain gutter info per line (1-based indexing)
+     */
+    getInfo: (lineInfo: number) => UsedInputGutterInfo;
+}
+/**
+ * Editor to handle and highlight user input
+ */
+export declare class BatchInputEditor extends CodeMirrorEditor {
     /**
      * Gutters to show which lines were used
      */
     private usedInputGutters;
+    private lastHighlightArgs?;
     constructor();
+    private getLastHighlightArgs;
+    protected onViewUpdate(v: ViewUpdate): void;
     /**
      * Apply highlighting to the lines in the Editor
-     * @param {function(number): UsedInputGutterInfo} getInfo Function to obtain gutter
-     * info per line (1-based indexing)
+     * @param {HightlightArgs} args Arguments for highlighting
+     * @param {Array<string>} highlightClasses HTML classes to use for consumed lines
      */
-    highlight(getInfo: (lineNr: number) => UsedInputGutterInfo): void;
+    highlight(args: HighlightArgs, highlightClasses?: string[]): void;
     /**
      * @return {Array<string>} Array of valid user input
      * Data in the last line that is not terminated by a newline is omitted
      */
     getLines(): Array<string>;
 }
+export {};

package/dist/editor/CodeMirrorEditor.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { Compartment, Extension } from "@codemirror/state";
-import { EditorView } from "@codemirror/view";
+import { EditorView, ViewUpdate } from "@codemirror/view";
 import { Renderable, RenderOptions } from "../util/Rendering";
 import { StyleSpec } from "style-mod";
 /**
@@ -62,6 +62,7 @@ export declare abstract class CodeMirrorEditor extends Renderable {
     static STYLE: string;
     static PLACEHOLDER: string;
     static THEME: string;
+    static LANGUAGE: string;
     /**
      * CodeMirror EditorView representing the internal editor
      */
@@ -83,6 +84,7 @@ export declare abstract class CodeMirrorEditor extends Renderable {
      * @param {EditorStyling} styling Data to style this editor
      */
     constructor(compartments: Set<string>, styling: EditorStyling);
+    protected onViewUpdate(v: ViewUpdate): void;
     /**
      * @param {Extension} extension The extension to add to the Editor
      */

package/dist/editor/DarkTheme.d.ts

@@ -0,0 +1 @@
+export declare const darkTheme: import("@codemirror/state").Extension;

package/dist/editor/Gutters.d.ts

@@ -23,6 +23,10 @@ export interface IGutterConfig<Info extends GutterInfo> {
      * Name of this Gutter
      */
     name: string;
+    /**
+     * HTML class names for the marker icons
+     */
+    markerClasses?: string;
     /**
      * Handler for when a Gutter element is clicked
      */
@@ -53,12 +57,19 @@ export declare abstract class Gutters<Info extends GutterInfo = GutterInfo, Conf
      * Will only be called when info.on is True
      */
     protected abstract marker(info: Info): GutterMarker;
+    private applyClasses;
+    hasMarker(view: EditorView, lineNr: number): boolean;
     /**
      * Set a marker with the given info
      * @param {EditorView} view View in which the Gutters live
      * @param {Info} info Info used to render the marker
      */
     setMarker(view: EditorView, info: Info): void;
+    /**
+     * @param {EditorView} view The view in which the Gutters live
+     * @return {Set<number>} The 1-based line numbers with a breakpoint
+     */
+    getMarkedLines(view: EditorView): Set<number>;
     /**
      * @return {Extension} The Gutters as a CodeMirror Extension
      */
@@ -70,11 +81,6 @@ export declare abstract class Gutters<Info extends GutterInfo = GutterInfo, Conf
 export declare class BreakpointsGutter extends Gutters {
     constructor();
     protected marker(): GutterMarker;
-    /**
-     * @param {EditorView} view The view in which the Gutters live
-     * @return {Set<number>} The 1-based line numbers with a breakpoint
-     */
-    getBreakpoints(view: EditorView): Set<number>;
 }
 /**
  * Extra data used to represent input gutters

package/dist/input/BatchInputHandler.d.ts

@@ -10,6 +10,10 @@ export declare class BatchInputHandler extends UserInputHandler {
      * Messages used when asking for user input
      */
     private prompts;
+    /**
+     * Whether a run is occurring
+     */
+    private running;
     /**
      * Editor containing the input of the user
      */
@@ -23,7 +27,7 @@ export declare class BatchInputHandler extends UserInputHandler {
      * Construct a new BatchInputHandler
      * @param {function()} inputCallback  Callback for when the user has entered a value
      */
-    constructor(inputCallback: () => void);
+    constructor(inputCallback: (line: string) => void);
     /**
      * Handle new input, potentially sending it to the awaiting receiver
      * @param {string} newInput The new user input

package/dist/input/UserInputHandler.d.ts

@@ -11,12 +11,12 @@ export declare abstract class UserInputHandler extends Renderable<InputManagerRe
     /**
      * Function to call when the user provided new input
      */
-    protected inputCallback: () => void;
+    protected inputCallback: (line: string) => void;
     /**
      * Construct a new UserInputHandler
      * @param {function()} inputCallback  Callback for when the user has entered a value
      */
-    constructor(inputCallback: () => void);
+    constructor(inputCallback: (line: string) => void);
     /**
      * Whether this handler has input ready
      */

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@dodona/papyros",
-  "version": "0.4.2",
+  "version": "0.5.1",
   "private": false,
-  "homepage": ".",
+  "homepage": "https://papyros.dodona.be/",
   "devDependencies": {
     "@types/escape-html": "^1.0.1",
     "@types/i18n-js": "^3.8.2",