1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 | package Torello.Browser; import java.util.*; import javax.json.*; import javax.json.stream.*; import java.io.*; import java.lang.reflect.Method; import java.lang.reflect.Parameter; import java.util.function.Function; import Torello.Java.Additional.*; import Torello.Java.JSON.*; import static Torello.Java.JSON.JFlag.*; import Torello.Java.StrCmpr; import Torello.JavaDoc.StaticFunctional; import Torello.JavaDoc.JDHeaderBackgroundImg; import Torello.JavaDoc.Excuse; /** * <SPAN CLASS=COPIEDJDK><B>This domain provides experimental commands only supported in headless mode.</B></SPAN> * * <EMBED CLASS='external-html' DATA-FILE-ID=CODE_GEN_NOTE> */ @StaticFunctional(Excused={"counter"}, Excuses={Excuse.CONFIGURATION}) @JDHeaderBackgroundImg(EmbedTagFileID="WOOD_PLANK_NOTE") public class HeadlessExperimental { // ******************************************************************************************** // ******************************************************************************************** // Class Header Stuff // ******************************************************************************************** // ******************************************************************************************** // No Pubic Constructors private HeadlessExperimental () { } // These two Vector's are used by all the "Methods" exported by this class. java.lang.reflect // is used to generate the JSON String's. It saves thousands of lines of Auto-Generated Code. private static final Map<String, Vector<String>> parameterNames = new HashMap<>(); private static final Map<String, Vector<Class<?>>> parameterTypes = new HashMap<>(); // Some Methods do not take any parameters - for instance all the "enable()" and "disable()" // I simply could not get ride of RAW-TYPES and UNCHECKED warnings... so there are now, // offically, two empty-vectors. One for String's, and the other for Classes. private static final Vector<String> EMPTY_VEC_STR = new Vector<>(); private static final Vector<Class<?>> EMPTY_VEC_CLASS = new Vector<>(); static { for (Method m : HeadlessExperimental.class.getMethods()) { // This doesn't work! The parameter names are all "arg0" ... "argN" // It works for java.lang.reflect.Field, BUT NOT java.lang.reflect.Parameter! // // Vector<String> parameterNamesList = new Vector<>(); -- NOPE! Vector<Class<?>> parameterTypesList = new Vector<>(); for (Parameter p : m.getParameters()) parameterTypesList.add(p.getType()); parameterTypes.put( m.getName(), (parameterTypesList.size() > 0) ? parameterTypesList : EMPTY_VEC_CLASS ); } } static { Vector<String> v = null; v = new Vector<String>(4); parameterNames.put("beginFrame", v); Collections.addAll(v, new String[] { "frameTimeTicks", "interval", "noDisplayUpdates", "screenshot", }); parameterNames.put("disable", EMPTY_VEC_STR); parameterNames.put("enable", EMPTY_VEC_STR); } // ******************************************************************************************** // ******************************************************************************************** // Types - Static Inner Classes // ******************************************************************************************** // ******************************************************************************************** /** Encoding options for a screenshot. */ public static class ScreenshotParams extends BaseType implements java.io.Serializable { /** For Object Serialization. java.io.Serializable */ protected static final long serialVersionUID = 1; public boolean[] optionals() { return new boolean[] { true, true, }; } /** * Image compression format (defaults to png). * <BR /> * <BR /><B>OPTIONAL</B> */ public final String format; /** * Compression quality from range [0..100] (jpeg only). * <BR /> * <BR /><B>OPTIONAL</B> */ public final Integer quality; /** * Constructor * * @param format Image compression format (defaults to png). * <BR />Acceptable Values: ["jpeg", "png"] * <BR /><B>OPTIONAL</B> * * @param quality Compression quality from range [0..100] (jpeg only). * <BR /><B>OPTIONAL</B> */ public ScreenshotParams(String format, Integer quality) { // Exception-Check(s) to ensure that if any parameters which must adhere to a // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw. BRDPC.checkIAE( "format", format, "jpeg", "png" ); this.format = format; this.quality = quality; } /** * JSON Object Constructor * @param jo A Json-Object having data about an instance of {@code 'ScreenshotParams'}. */ public ScreenshotParams (JsonObject jo) { this.format = ReadJSON.getString(jo, "format", true, false); this.quality = ReadBoxedJSON.getInteger(jo, "quality", true); } /** Checks whether {@code 'this'} equals an input Java-{@code Object} */ public boolean equals(Object other) { if (other == null) return false; if (other.getClass() != this.getClass()) return false; ScreenshotParams o = (ScreenshotParams) other; return Objects.equals(this.format, o.format) && Objects.equals(this.quality, o.quality); } /** Generates a Hash-Code for {@code 'this'} instance */ public int hashCode() { return Objects.hashCode(this.format) + Objects.hashCode(this.quality); } } /** * Issued when the target starts or stops needing BeginFrames. * Deprecated. Issue beginFrame unconditionally instead and use result from * beginFrame to detect whether the frames were suppressed. * <BR /> * <BR /><B>DEPRECATED</B> */ public static class needsBeginFramesChanged extends BrowserEvent implements java.io.Serializable { /** For Object Serialization. java.io.Serializable */ protected static final long serialVersionUID = 1; public boolean[] optionals() { return new boolean[] { false, }; } /** True if BeginFrames are needed, false otherwise. */ public final boolean needsBeginFrames; /** * Constructor * * @param needsBeginFrames True if BeginFrames are needed, false otherwise. */ public needsBeginFramesChanged(boolean needsBeginFrames) { super("HeadlessExperimental", "needsBeginFramesChanged", 1); this.needsBeginFrames = needsBeginFrames; } /** * JSON Object Constructor * @param jo A Json-Object having data about an instance of {@code 'needsBeginFramesChanged'}. */ public needsBeginFramesChanged (JsonObject jo) { super("HeadlessExperimental", "needsBeginFramesChanged", 1); this.needsBeginFrames = ReadPrimJSON.getBoolean(jo, "needsBeginFrames"); } /** Checks whether {@code 'this'} equals an input Java-{@code Object} */ public boolean equals(Object other) { if (other == null) return false; if (other.getClass() != this.getClass()) return false; needsBeginFramesChanged o = (needsBeginFramesChanged) other; return (this.needsBeginFrames == o.needsBeginFrames); } /** Generates a Hash-Code for {@code 'this'} instance */ public int hashCode() { return (this.needsBeginFrames ? 1 : 0); } } // Counter for keeping the WebSocket Request ID's distinct. private static int counter = 1; /** * Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a * screenshot from the resulting frame. Requires that the target was created with enabled * BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also * https://goo.gl/3zHXhB for more background. * * @param frameTimeTicks * Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set, * the current time will be used. * <BR /><B>OPTIONAL</B> * * @param interval * The interval between BeginFrames that is reported to the compositor, in milliseconds. * Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds. * <BR /><B>OPTIONAL</B> * * @param noDisplayUpdates * Whether updates should not be committed and drawn onto the display. False by default. If * true, only side effects of the BeginFrame will be run, such as layout and animations, but * any visual updates may not be visible on the display or in screenshots. * <BR /><B>OPTIONAL</B> * * @param screenshot * If set, a screenshot of the frame will be captured and returned in the response. Otherwise, * no screenshot will be captured. Note that capturing a screenshot can fail, for example, * during renderer initialization. In such a case, no screenshot data will be returned. * <BR /><B>OPTIONAL</B> * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret2}></CODE> * * <BR /><BR />This {@link Script} may be <B STYLE='color:red'>executed</B> (using * {@link Script#exec()}), and a {@link Promise} returned. * * <BR /><BR />When the {@code Promise} is <B STYLE='color: red'>awaited</B> * (using {@link Promise#await()}), the {@code Ret2} will subsequently * be returned from that call. * * <BR /><BR />The <B STYLE='color: red'>returned</B> values are encapsulated * in an instance of <B>{@link Ret2}</B> * * <BR /><BR /><UL CLASS=JDUL> * <LI><CODE><B>Ret2.a:</B> Boolean (<B>hasDamage</B>)</CODE> * <BR />Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the * display. Reported for diagnostic uses, may be removed in the future. * <BR /><BR /></LI> * <LI><CODE><B>Ret2.b:</B> String (<B>screenshotData</B>)</CODE> * <BR />Base64-encoded image data of the screenshot, if one was requested and successfully taken. (Encoded as a base64 string when passed over JSON) * </LI> * </UL> */ public static Script<String, JsonObject, Ret2<Boolean, String>> beginFrame( Number frameTimeTicks, Number interval, Boolean noDisplayUpdates, HeadlessExperimental.ScreenshotParams screenshot ) { final int webSocketID = 22000000 + counter++; final boolean[] optionals = { true, true, true, true, }; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("beginFrame"), parameterNames.get("beginFrame"), optionals, webSocketID, "HeadlessExperimental.beginFrame", frameTimeTicks, interval, noDisplayUpdates, screenshot ); // 'JSON Binding' ... Converts Browser Response-JSON into Java-Type 'Ret2' Function<JsonObject, Ret2<Boolean, String>> responseProcessor = (JsonObject jo) -> new Ret2<>( ReadBoxedJSON.getBoolean(jo, "hasDamage", true), ReadJSON.getString(jo, "screenshotData", true, false) ); // Pass the 'defaultSender' to Script-Constructor // The sender that is used can be changed before executing script. return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor); } /** * Disables headless events for the target. * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret0}></CODE> * * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the * browser receives the invocation-request. * * <BR /><BR />This Browser-Function <I>does not have</I> a return-value. You may choose to * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0} * {@code >} to ensure the Browser Function has run to completion. */ public static Script<String, JsonObject, Ret0> disable() { final int webSocketID = 22001000 + counter++; final boolean[] optionals = new boolean[0]; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("disable"), parameterNames.get("disable"), optionals, webSocketID, "HeadlessExperimental.disable" ); // This Remote Command does not have a Return-Value. return new Script<> (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues); } /** * Enables headless events for the target. * * @return An instance of <CODE>{@link Script}<String, {@link JsonObject}, * {@link Ret0}></CODE> * * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the * browser receives the invocation-request. * * <BR /><BR />This Browser-Function <I>does not have</I> a return-value. You may choose to * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0} * {@code >} to ensure the Browser Function has run to completion. */ public static Script<String, JsonObject, Ret0> enable() { final int webSocketID = 22002000 + counter++; final boolean[] optionals = new boolean[0]; // Convert Method Parameters into JSON. Build the JSON Request-Object (as a String) String requestJSON = WriteJSON.get( parameterTypes.get("enable"), parameterNames.get("enable"), optionals, webSocketID, "HeadlessExperimental.enable" ); // This Remote Command does not have a Return-Value. return new Script<> (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues); } } |