@dodona/papyros 0.4.1 → 0.5.0

package/dist/Papyros.d.ts

@@ -1,5 +1,5 @@
 import "./Papyros.css";
-import { InputMode } from "./InputManager";
+import { InputManagerRenderOptions, InputMode } from "./InputManager";
 import { ProgrammingLanguage } from "./ProgrammingLanguage";
 import { RunState, CodeRunner } from "./CodeRunner";
 import { AtomicsChannelOptions, ServiceWorkerChannelOptions } from "sync-message";
@@ -54,7 +54,7 @@ export interface PapyrosRenderOptions {
     /**
      * RenderOptions for the input field
      */
-    inputOptions?: RenderOptions;
+    inputOptions?: InputManagerRenderOptions;
     /**
      * RenderOptions for the output field
      */

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
      */
@@ -116,9 +118,9 @@ export declare abstract class CodeMirrorEditor extends Renderable {
     setDarkMode(darkMode: boolean): void;
     /**
      * Override the style used by this Editor
-     * @param {any} styling Object with keys of EditorStyling to override styles
+     * @param {Partial<EditorStyling>} styling Object with keys of EditorStyling to override styles
      */
-    setStyling(styling: any): void;
+    setStyling(styling: Partial<EditorStyling>): void;
     protected _render(options: RenderOptions): void;
     /**
      * Process the changes by informing the listeners of the new contents

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

@@ -1,6 +1,5 @@
-import { InputMode } from "../InputManager";
+import { InputManagerRenderOptions, InputMode } from "../InputManager";
 import { UserInputHandler } from "./UserInputHandler";
-import { RenderOptions } from "../util/Rendering";
 import { BatchInputEditor } from "../editor/BatchInputEditor";
 export declare class BatchInputHandler extends UserInputHandler {
     /**
@@ -11,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
      */
@@ -24,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
@@ -45,5 +48,5 @@ export declare class BatchInputHandler extends UserInputHandler {
     waitWithPrompt(waiting: boolean, prompt?: string): void;
     protected setPlaceholder(placeholderValue: string): void;
     focus(): void;
-    protected _render(options: RenderOptions): void;
+    protected _render(options: InputManagerRenderOptions): void;
 }

package/dist/input/InteractiveInputHandler.d.ts

@@ -9,12 +9,19 @@ export declare class InteractiveInputHandler extends UserInputHandler {
      * Retrieve the button that users can click to send their input
      */
     private get sendButton();
+    /**
+     * Retrieve the HTMLInputElement for this InputHandler
+     */
+    private get inputArea();
     getInputMode(): InputMode;
     hasNext(): boolean;
     next(): string;
     waitWithPrompt(waiting: boolean, prompt?: string): void;
+    protected setPlaceholder(placeholder: string): void;
+    focus(): void;
     toggle(): void;
     onRunStart(): void;
     onRunEnd(): void;
     protected _render(options: RenderOptions): void;
+    protected reset(): void;
 }

package/dist/input/UserInputHandler.d.ts

@@ -1,19 +1,22 @@
-import { InputMode } from "../InputManager";
+import { InputManagerRenderOptions, InputMode } from "../InputManager";
 import { Renderable } from "../util/Rendering";
 /**
  * Base class for components that handle input from the user
  */
-export declare abstract class UserInputHandler extends Renderable {
+export declare abstract class UserInputHandler extends Renderable<InputManagerRenderOptions> {
     /**
      * Whether we are waiting for the user to input data
      */
     protected waiting: boolean;
-    protected inputCallback: () => void;
+    /**
+     * Function to call when the user provided new input
+     */
+    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
      */
@@ -44,18 +47,14 @@ export declare abstract class UserInputHandler extends Renderable {
      * @param {boolean} active Whether this component is active
      */
     abstract toggle(active: boolean): void;
-    /**
-     * Retrieve the HTMLInputElement for this InputHandler
-     */
-    get inputArea(): HTMLInputElement;
     /**
      * @param {string} placeholder The placeholder to show
      */
-    protected setPlaceholder(placeholder: string): void;
+    protected abstract setPlaceholder(placeholder: string): void;
     /**
      * Focus the area in which the user enters input
      */
-    focus(): void;
+    abstract focus(): void;
     /**
      * Wait for input of the user for a certain prompt
      * @param {boolean} waiting Whether we are waiting for input

package/package.json

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