deftry_cmd(
+ raise_exc:type[Exception]=GeorgeError,
+ catch_exc:type[Exception]=GeorgeError,
+ exception_msg:str|None=None,
+)->Callable[[T],T]:
+"""Decorator that does a try/except with GeorgeError by default.
+
+ It raises the error with the custom exception message provided.
+
+ Args:
+ raise_exc: the exception to raise. Defaults to GeorgeError.
+ catch_exc: the exception to catch. Defaults to GeorgeError.
+ exception_msg: Custom exception message. Defaults to None.
+
+ Returns:
+ the decorated function
+ """
+
+ defdecorate(func:T)->T:
+ @functools.wraps(func)
+ defapplicator(*args:Any,**kwargs:Any)->Any:
+ try:
+ returnfunc(*args,**kwargs)
+ exceptcatch_excase:
+ raiseraise_exc(exception_msgore)
+
+ returncast(T,applicator)
+
+ returndecorate
+
defsend_cmd(
+ command:str,
+ *args:Any,
+ error_values:list[Any]|None=None,
+ handle_string:bool=True,
+)->str:
+"""Send a George command with the provided arguments to TVPaint.
+
+ Catch basic `ERROR XX` errors returned from George, but you can provide your own error values.
+
+ Args:
+ command: the George command to send
+ *args: pass any arguments you want to that function
+ error_values: a list of error values to catch from George. Defaults to None.
+ handle_string: control the quote wrapping of string with spaces. Defaults to True.
+
+ Raises:
+ GeorgeError: if we received `ERROR XX` or any of the custom error codes
+
+ Returns:
+ the George return string
+ """
+ tv_args=[
+ tv_handle_string(arg)ifhandle_stringandisinstance(arg,str)elsearg
+ forarginargs
+ ]
+ cmd_str=" ".join([str(arg)forargin[command,*tv_args]])
+
+ is_undo_stack=commandin[
+ "tv_UndoOpenStack",
+ "tv_UpdateUndo",
+ "tv_UndoCloseStack",
+ ]
+
+ ifnotis_undo_stack:
+ log.debug(f"[RPC] >> {cmd_str}")
+
+ response=rpc_client.execute_remote("execute_george",[cmd_str])
+ result=response["result"]
+
+ ifnotis_undo_stack:
+ log.debug(f"[RPC] << {result}")
+
+ # Test for basic ERROR X values and user provided custom errors
+ res_in_error_values=error_valuesandresultinlist(map(str,error_values))
+ ifres_in_error_valuesorre.match(r"ERROR -?\d+",result,re.IGNORECASE):
+ msg=f"Received value: '{result}' considered as an error"
+ raiseGeorgeError(msg,error_value=result)
+
+ returnresult
+
defrun_script(script:Path|str)->None:
+"""Execute a George script from a .grg file.
+
+ Args:
+ script: the path to the script
+
+ Raises:
+ ValueError: if the script was not found
+ """
+ script=Path(script)
+ ifnotscript.exists():
+ raiseValueError(f"Script not found at : {script.as_posix()}")
+ send_cmd("tv_RunScript",script.as_posix())
+
deftv_handle_string(s:str)->str:
+"""String handling for George arguments. It wraps the string into quotes if it has spaces.
+
+ See an example here: https://www.tvpaint.com/doc/tvpaint-animation-11/george-commands#tv_projectnew
+
+ Args:
+ s (str): the input string
+
+ Returns:
+ the "escaped" string
+ """
+ if" "ins:
+ returnf'"{s}"'
+
+ returns
+
deftv_cast_to_type(value:str,cast_type:type[T])->T:
+"""Cast a value to the provided type using George's convention for values.
+
+ Note:
+ "1" and "on"/"ON" values are considered True when parsing a boolean
+
+ Args:
+ value: the input value
+ cast_type: the type to cast to
+
+ Raises:
+ ValueError: if given an enum, and it can't find the value or the enum index is invalid
+
+ Returns:
+ the value cast to the provided type
+ """
+ ifissubclass(cast_type,Enum):
+ value=value.strip().strip('"')
+
+ # Find all enum members that matches the value (lower case)
+ matches=[mformincast_typeifvalue.lower()==m.value.lower()]
+ try:
+ # If the unmodified value is in the enum, return that first
+ returncast(T,next(mforminmatchesifvalue==m.value))
+ exceptStopIteration:
+ # Otherwise return the first match
+ ifmatches:
+ returncast(T,matches[0])
+
+ # It didn't work, it can be the enum index
+ try:
+ index=int(value)
+ exceptValueError:
+ raiseValueError(
+ f"{value} is not a valid Enum index since it can't be parsed as int"
+ )
+
+ # We get the enum member at that index
+ enum_members=list(cast_type)
+ ifindex<len(enum_members):
+ returncast(T,enum_members[index])
+
+ raiseValueError(
+ f"Enum index {index} is out of bounds (max {len(enum_members)-1})"
+ )
+
+ ifget_origin(cast_type)istuple:
+ # Split by space and convert each member to the right type
+ values_types=zip(value.split(" "),get_args(cast_type))
+ returncast(T,tuple(tv_cast_to_type(v,t)forv,tinvalues_types))
+
+ ifcast_type==bool:
+ returncast(T,value.lower()in["1","on","true"])
+
+ ifcast_type==str:
+ returncast(T,value.strip().strip('"'))
+
+ returncast(T,cast_type(value))
+
deftv_parse_dict(
+ input_text:str,
+ with_fields:FieldTypes|type[DataclassInstance],
+)->dict[str,Any]:
+"""Parse a list of values as key value pairs returned from TVPaint commands.
+
+ Cast the values to a provided dataclass type or list of key/types pairs.
+
+ Args:
+ input_text: the George string result
+ with_fields: the field types (can be a dataclass)
+
+ Returns:
+ a dict with the values cast to the given types
+ """
+ # For dataclasses get the type hints and filter those with metadata
+ ifis_dataclass(with_fields):
+ with_fields=_get_dataclass_fields(with_fields)
+ else:
+ # Explicitly cast because we are sure now
+ with_fields=cast(FieldTypes,with_fields)
+
+ output_dict:dict[str,Any]={}
+ search_start=0
+
+ fori,(field_name,field_type)inenumerate(with_fields):
+ current_key_pascal=camel_to_pascal(field_name)
+
+ # Search for the key from the end
+ search_text=input_text.lower()
+ try:
+ start=search_text.index(current_key_pascal.lower(),search_start)
+ exceptValueError:
+ continue
+
+ ifi<(len(with_fields)-1):
+ # Search for the next key also from the end
+ next_key_pascal=camel_to_pascal(with_fields[i+1][0])
+ end=search_text.rfind(" "+next_key_pascal.lower(),search_start)
+ else:
+ end=len(input_text)
+
+ # Get the "key value" substring
+ key_value=input_text[start:end]
+
+ # Extract the value
+ cut_at=len(current_key_pascal)+1
+ value=key_value[cut_at:].strip()
+
+ # Cast it to the corresponding type
+ value=tv_cast_to_type(value,field_type)
+
+ output_dict[field_name]=value
+ search_start=end
+
+ returnoutput_dict
+
deftv_parse_list(
+ output:str,
+ with_fields:FieldTypes|type[DataclassInstance],
+ unused_indices:list[int]|None=None,
+)->dict[str,Any]:
+"""Parse a list of values returned from TVPaint commands.
+
+ Cast the values to a provided dataclass type or list of key/types pairs.
+
+ You can specify unused indices to exclude positional values from being parsed.
+ This is useful because some George commands have unused return values.
+
+ Args:
+ output: the input string
+ with_fields: the field types (can be a dataclass)
+ unused_indices: Some George functions return positional arguments that are unused. Defaults to None.
+
+ Returns:
+ a dict with the values cast to the given types
+ """
+ start=0
+ current=0
+ string_open=False
+ tokens:list[str]=[]
+
+ whilecurrent<len(output):
+ char=output[current]
+ is_quote=char=='"'
+ is_space=char==" "
+ last_char=current==len(output)-1
+
+ if(is_spaceandnotstring_open)orlast_char:
+ last_cut=currentifnotlast_charelsecurrent+1
+ token=output[start:last_cut]
+ ifstart!=last_cutandtoken!=" ":
+ tokens.append(token)
+ start=current=current+1
+ elifis_quote:
+ ifstring_open:
+ tokens.append(output[start:current])
+
+ start=current=current+1
+ string_open=notstring_open
+ else:
+ current+=1
+
+ # Get type annotations from the dataclass fields
+ ifis_dataclass(with_fields):
+ with_fields=_get_dataclass_fields(with_fields)
+ else:
+ # Explicitly cast because we are sure now
+ with_fields=cast(FieldTypes,with_fields)
+
+ # Remove any unused values
+ ifunused_indices:
+ tokens=[tfori,tinenumerate(tokens)ifinotinunused_indices]
+
+ # Cast each token to a type and construct the dict
+ tokens_dict:dict[str,Any]={}
+ fortoken,(field_name,field_type)inzip(tokens,with_fields):
+ token=tv_cast_to_type(token,field_type)
+ tokens_dict[field_name]=token
+
+ returntokens_dict
+
defargs_dict_to_list(args:dict[str,Any])->list[Any]:
+"""Converts a dict of named arguments to a flat list of key/values.
+
+ It also filters pairs with None values
+
+ Args:
+ args: dict of arguments
+
+ Returns:
+ key/values list
+ """
+ args_filter={k:vfork,vinargs.items()ifvisnotNone}
+ # Flatten dictionnary key value pairs with zip
+ return[itemforkvinargs_filter.items()foriteminkv]
+
Some George functions only accept a list of values and not key:value pairs, so to set the last positional argument for instance, you need to give all the previous ones.
+
This function allows you to give a list of argument or key:value pairs (as tuples) and check that they are not None.
+
For example, for tv_camerainfo [<iWidth> <iHeight> [<field_order>]]
+you can't give [500, None, "upper"] because <iHeight> is not defined.
defvalidate_args_list(optional_args:Sequence[Value|tuple[Value,...]])->list[Any]:
+"""Some George functions only accept a list of values and not key:value pairs, so to set the last positional argument for instance, you need to give all the previous ones.
+
+ This function allows you to give a list of argument or key:value pairs (as tuples) and check that they are not None.
+
+ For example, for `tv_camerainfo [<iWidth> <iHeight> [<field_order>]]`
+ you can't give `[500, None, "upper"]` because `<iHeight>` is not defined.
+
+ Args:
+ optional_args: list of values or tuple of values (args block)
+
+ Raises:
+ ValueError: if not all the parameters were given
+
+ Returns:
+ the list of parameters
+ """
+ args:list[Any]=[]
+
+ forarginoptional_args:
+ ifargisNoneor(isinstance(arg,tuple)andall(aisNoneforainarg)):
+ break
+
+ # If it's a tuple they need to be defined
+ ifisinstance(arg,tuple):
+ ifany(aisNoneforainarg):
+ raiseValueError(f"You must pass all the parameters: {arg}")
+ args.extend(arg)
+ else:
+ args.append(arg)
+
+ returnargs
+
defexecute_remote(
+ self,
+ method:str,
+ params:list[JSONValueType]|None=None,
+)->JSONRPCResponse:
+"""Executes a remote procedure call.
+
+ Args:
+ method: the name of the method to be invoked
+ params: the parameter values to be used during the invocation of the method. Defaults to None.
+
+ Raises:
+ ConnectionError: if the client is not connected
+ JSONRPCResponseError: if there was an error server-side
+
+ Returns:
+ JSONRPCResponse: the JSON-RPC response payload
+ """
+ ifnotself.is_connected:
+ raiseConnectionError(
+ f"Can't send rpc message because the client is not connected to {self.url}"
+ )
+
+ payload:JSONRPCPayload={
+ "jsonrpc":self.jsonrpc_version,
+ "id":self.rpc_id,
+ "method":method,
+ "params":paramsor[],
+ }
+
+ self.ws_handle.send(json.dumps(payload))
+ self.increment_rpc_id()
+
+ result=self.ws_handle.recv()
+ response=cast(JSONRPCResponse,json.loads(result))
+
+ if"error"inresponse:
+ raiseJSONRPCResponseError(response["error"])
+
+ returnresponse
+
+
+
+ Source code in pytvpaint/george/grg_camera.py
+
37
+38
+39
deftv_camera_info_get()->TVPCamera:
+"""Get the information of the camera."""
+ returnTVPCamera(**tv_parse_list(send_cmd("tv_CameraInfo"),with_fields=TVPCamera))
+
Get the position/angle/scale values of the n-th point of the camera path.
+
+
+ Source code in pytvpaint/george/grg_camera.py
+
63
+64
+65
+66
deftv_camera_enum_points(index:int)->TVPCameraPoint:
+"""Get the position/angle/scale values of the n-th point of the camera path."""
+ res=send_cmd("tv_CameraEnumPoints",index,error_values=[GrgErrorValue.NONE])
+ returnTVPCameraPoint(**tv_parse_list(res,with_fields=TVPCameraPoint))
+
Get the position/angle/scale values at the given position on the camera path (between 0 and 1).
+
+
+ Source code in pytvpaint/george/grg_camera.py
+
69
+70
+71
+72
+73
+74
+75
deftv_camera_interpolation(position:float)->TVPCameraPoint:
+"""Get the position/angle/scale values at the given position on the camera path (between 0 and 1)."""
+ res=tv_parse_list(
+ send_cmd("tv_CameraInterpolation",position),
+ with_fields=TVPCameraPoint,
+ )
+ returnTVPCameraPoint(**res)
+
Add a point to the camera path before the given index.
+
+
+ Source code in pytvpaint/george/grg_camera.py
+
78
+79
+80
+81
+82
+83
+84
+85
+86
deftv_camera_insert_point(
+ index:int,
+ x:float,
+ y:float,
+ angle:float,
+ scale:float,
+)->None:
+"""Add a point to the camera path *before* the given index."""
+ send_cmd("tv_CameraInsertPoint",index,x,y,angle,scale)
+
Set position/angle/scale value of a point at the given index and make it current.
+
+
+ Source code in pytvpaint/george/grg_camera.py
+
94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
deftv_camera_set_point(
+ index:int,
+ x:float,
+ y:float,
+ angle:float,
+ scale:float,
+)->None:
+"""Set position/angle/scale value of a point at the given index and make it current."""
+ send_cmd("tv_CameraSetPoint",index,x,y,angle,scale)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid clip id",
+)
+deftv_clip_info(clip_id:int)->TVPClip:
+"""Get the information of the given clip.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid clip id
+ """
+ result=send_cmd("tv_ClipInfo",clip_id,error_values=[GrgErrorValue.EMPTY])
+ clip=tv_parse_dict(result,with_fields=TVPClip)
+ clip["id"]=clip_id
+ returnTVPClip(**clip)
+
@try_cmd(
+ exception_msg="Invalid scene id or clip position or elements have been removed"
+)
+deftv_clip_enum_id(scene_id:int,clip_position:int)->int:
+"""Get the id of the clip at the given position inside the given scene.
+
+ Raises:
+ GeorgeError: if given an invalid scene id or clip position or elements have been removed
+ """
+ returnint(
+ send_cmd(
+ "tv_ClipEnumId",
+ scene_id,
+ clip_position,
+ error_values=[GrgErrorValue.NONE],
+ )
+ )
+
@try_cmd(exception_msg="Invalid format for sequence")
+deftv_load_sequence(
+ seq_path:Path|str,
+ offset_count:tuple[int,int]|None=None,
+ field_order:FieldOrder|None=None,
+ stretch:bool=False,
+ time_stretch:bool=False,
+ preload:bool=False,
+)->int:
+"""Load a sequence of images or movie in a new layer.
+
+ Args:
+ seq_path: the first file of the sequence to load
+ offset_count: the start and number of images in the sequence to load. Defaults to None.
+ field_order: the field order. Defaults to None.
+ stretch: Stretch each image to the size of the layer. Defaults to None.
+ time_stretch: Once loaded, the layer will have a new number of images corresponding to the project framerate. Defaults to None.
+ preload: Load all the images in memory, no more reference on the files. Defaults to None.
+
+ Raises:
+ FileNotFoundError: if the sequence file doesn't exist
+ GeorgeError: if the input file is in an invalid format
+
+ Returns:
+ the number of images of the new layer
+ """
+ seq_path=Path(seq_path)
+
+ ifnotseq_path.exists():
+ raiseFileNotFoundError(f"File not found at: {seq_path.as_posix()}")
+
+ args:list[int|str]=[seq_path.as_posix()]
+ ifoffset_countandlen(offset_count)==2:
+ args.extend(offset_count)
+ iffield_order:
+ args.append(field_order.value)
+
+ extra_args=[
+ (stretch,"stretch"),
+ (time_stretch,"timestretch"),
+ (preload,"preload"),
+ ]
+ forparam,param_nameinextra_args:
+ ifnotparam:
+ continue
+ args.append(param_name)
+
+ result=send_cmd(
+ "tv_LoadSequence",
+ *args,
+ error_values=[-1],
+ )
+
+ returnint(result)
+
+
+
+ Source code in pytvpaint/george/grg_clip.py
+
298
+299
+300
+301
+302
+303
+304
+305
+306
+307
@try_cmd(exception_msg="No bookmark at provided position")
+deftv_bookmarks_enum(position:int)->int:
+"""Get the frame (in the clip) corresponding to the bookmark at the given position.
+
+ Raises:
+ GeorgeError: if no bookmark found at provided position
+ """
+ returnint(
+ send_cmd("tv_BookmarksEnum",position,error_values=[GrgErrorValue.NONE])
+ )
+
+
+
+ Source code in pytvpaint/george/grg_clip.py
+
340
+341
+342
+343
+344
+345
deftv_clip_action_get(clip_id:int)->str:
+"""Get the action text of the clip."""
+ # We explicitly check if the clip exists because the error value is an empty string, and we can't determine if the
+ # action text is empty or the clip_id is invalid...
+ tv_clip_name_get(clip_id)
+ returnsend_cmd("tv_ClipAction",clip_id)
+
+
+
+ Source code in pytvpaint/george/grg_clip.py
+
348
+349
+350
+351
+352
deftv_clip_action_set(clip_id:int,text:str)->None:
+"""Set the action text of the clip."""
+ # See tv_clip_action_get above
+ tv_clip_name_get(clip_id)
+ send_cmd("tv_ClipAction",clip_id,text)
+
+
+
+ Source code in pytvpaint/george/grg_clip.py
+
355
+356
+357
+358
+359
deftv_clip_dialog_get(clip_id:int)->str:
+"""Get the dialog text of the clip."""
+ # See tv_clip_action_get above
+ tv_clip_name_get(clip_id)
+ returnsend_cmd("tv_ClipDialog",clip_id)
+
+
+
+ Source code in pytvpaint/george/grg_clip.py
+
362
+363
+364
+365
+366
deftv_clip_dialog_set(clip_id:int,dialog:str)->None:
+"""Set the dialog text of the clip."""
+ # See tv_clip_action_get above
+ tv_clip_name_get(clip_id)
+ send_cmd("tv_ClipDialog",clip_id,dialog)
+
+
+
+ Source code in pytvpaint/george/grg_clip.py
+
369
+370
+371
+372
+373
deftv_clip_note_get(clip_id:int)->str:
+"""Get the note text of the clip."""
+ # See tv_clip_action_get above
+ tv_clip_name_get(clip_id)
+ returnsend_cmd("tv_ClipNote",clip_id)
+
+
+
+ Source code in pytvpaint/george/grg_clip.py
+
376
+377
+378
+379
+380
deftv_clip_note_set(clip_id:int,note:str)->None:
+"""Set the note text of the clip."""
+ # See tv_clip_action_get above
+ tv_clip_name_get(clip_id)
+ send_cmd("tv_ClipNote",clip_id,note)
+
deftv_clip_save_structure_sprite(
+ export_path:Path|str,
+ layout:SpriteLayout|None=None,
+ space:int|None=None,
+)->None:
+"""Save the current clip as sprites in one image.
+
+ Args:
+ export_path: the export path of the sprite image
+ layout: the sprite layout. Defaults to None.
+ space: the space between each sprite in the image. Defaults to None.
+ """
+ export_path=Path(export_path)
+
+ args=args_dict_to_list(
+ {
+ "layout":layout.valueiflayoutisnotNoneelseNone,
+ "space":space,
+ }
+ )
+
+ send_cmd(
+ "tv_ClipSaveStructure",
+ export_path.as_posix(),
+ "sprite",
+ *args,
+ error_values=[-1],
+ )
+
deftv_clip_save_structure_flix(
+ export_path:Path|str,
+ mark_in:int|None=None,
+ mark_out:int|None=None,
+ parameters_import:str|None=None,
+ parameters_file:str|None=None,
+ send:bool|None=None,
+ original_file:str|Path|None=None,
+)->None:
+"""Save the current clip for Flix.
+
+ Args:
+ export_path: the .xml export path
+ mark_in: the start frame to render. Defaults to None.
+ mark_out: the end frame to render. Defaults to None.
+ parameters_import: the attribute(s) of the global <flixImport> tag (waitForSource/...). Defaults to None.
+ parameters_file: the attribute(s) of each <image> (file) tag (dialogue/...). Defaults to None.
+ send: open a browser with the prefilled url. Defaults to None.
+ original_file: the original reference tvpp file path. Defaults to None.
+ """
+ export_path=Path(export_path)
+
+ args_dict={
+ "markin":mark_in,
+ "markout":mark_out,
+ "parametersimport":parameters_import,
+ "parametersfile":parameters_file,
+ "send":int(send)ifsendelseNone,
+ "originalfile":Path(original_file).as_posix()iforiginal_fileelseNone,
+ }
+
+ args=args_dict_to_list(args_dict)
+
+ send_cmd(
+ "tv_ClipSaveStructure",
+ export_path.as_posix(),
+ "Flix",
+ *args,
+ error_values=[-1],
+ )
+
+
+
+ Source code in pytvpaint/george/grg_clip.py
+
600
+601
+602
+603
+604
deftv_sound_clip_info(clip_id:int,track_index:int)->TVPSound:
+"""Get information about a soundtrack."""
+ res=send_cmd("tv_SoundClipInfo",clip_id,track_index,error_values=[-1,-2,-3])
+ res_parse=tv_parse_list(res,with_fields=TVPSound)
+ returnTVPSound(**res_parse)
+
+
+
+ Source code in pytvpaint/george/grg_clip.py
+
607
+608
+609
+610
+611
+612
deftv_sound_clip_new(sound_path:Path|str)->None:
+"""Add a new soundtrack."""
+ path=Path(sound_path)
+ ifnotpath.exists():
+ raiseValueError(f"Sound file not found at : {path.as_posix()}")
+ send_cmd("tv_SoundClipNew",path.as_posix(),error_values=[-1,-2,-3,-4])
+
deftv_sound_clip_reload(clip_id:int,track_index:int)->None:
+"""Reload a soundtrack from its file.
+
+ Args:
+ clip_id: the clip id (only works with `0` being the current clip)
+ track_index: the sound clip track index
+
+ Warning:
+ this doesn't accept a proper clip id, only `0` seem to work for the current clip
+ """
+ send_cmd("tv_SoundClipReload",clip_id,track_index,error_values=[-1,-2,-3])
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
203
+204
+205
+206
+207
+208
+209
+210
+211
@try_cmd(exception_msg="No layer at provided position")
+deftv_layer_get_id(position:int)->int:
+"""Get the id of the layer at the given position.
+
+ Raises:
+ GeorgeError: if no layer found at the provided position
+ """
+ result=send_cmd("tv_LayerGetID",position,error_values=[GrgErrorValue.NONE])
+ returnint(result)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_get_pos(layer_id:int)->int:
+"""Get the position of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ returnint(send_cmd("tv_LayerGetPos",layer_id,error_values=[GrgErrorValue.NONE]))
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_info(layer_id:int)->TVPLayer:
+"""Get information of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ result=send_cmd("tv_LayerInfo",layer_id,error_values=[GrgErrorValue.EMPTY])
+ layer=tv_parse_list(result,with_fields=TVPLayer,unused_indices=[7,8])
+ layer["id"]=layer_id
+ returnTVPLayer(**layer)
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
243
+244
+245
+246
+247
+248
+249
+250
@try_cmd(exception_msg="Couldn't move current layer to position")
+deftv_layer_move(position:int)->None:
+"""Move the current layer to a new position in the layer stack.
+
+ Raises:
+ GeorgeError: if layer could not be moved
+ """
+ send_cmd("tv_LayerMove",position)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_set(layer_id:int)->None:
+"""Make the given layer the current one.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd("tv_LayerSet",layer_id)
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
266
+267
+268
+269
+270
+271
+272
+273
+274
@try_cmd(raise_exc=NoObjectWithIdError,exception_msg="Invalid layer id")
+deftv_layer_selection_get(layer_id:int)->bool:
+"""Get the selection state of a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd("tv_LayerSelection",layer_id,error_values=[-1])
+ returntv_cast_to_type(res,bool)
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
277
+278
+279
+280
+281
+282
+283
+284
@try_cmd(raise_exc=NoObjectWithIdError,exception_msg="Invalid layer id")
+deftv_layer_selection_set(layer_id:int,new_state:bool)->None:
+"""Set the selection state of a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd("tv_LayerSelection",layer_id,int(new_state),error_values=[-1])
+
If the start position is before the beginning of the layer, the selection will only start at the beginning of
+the layer, but its length will be measured from the start position.
+This means that if you ask for a selection of 15 frames starting from position 0 in a layer that actually
+starts at position 5, only the first 10 frames in the layer will be selected.
+If the selection goes beyond the end of the layer, it will only include the frames between the start and end of
+the layer. No frames will be selected if the start position is beyond the end of the layer
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
deftv_layer_select(start_frame:int,frame_count:int)->int:
+"""Select frames in the current layer.
+
+ Args:
+ start_frame: selection start
+ frame_count: number of frames to select
+
+ Returns:
+ int: number of frames selected
+
+ Note:
+ If the start position is before the beginning of the layer, the selection will only start at the beginning of
+ the layer, but its length will be measured from the start position.
+ This means that if you ask for a selection of 15 frames starting from position 0 in a layer that actually
+ starts at position 5, only the first 10 frames in the layer will be selected.
+ If the selection goes beyond the end of the layer, it will only include the frames between the start and end of
+ the layer. No frames will be selected if the start position is beyond the end of the layer
+ """
+ returnint(send_cmd("tv_LayerSelect",start_frame,frame_count,error_values=[-1]))
+
The official documentation states that this functions selects the layer frames, it does not, it simply
+returns the frames selected. This will also return all frames in the layer even if they are not selected if the
+argument full is set to True. We advise using tv_layer_select to select your frames and only using this
+function to get the selected frames.
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
deftv_layer_select_info(full:bool=False)->tuple[int,int]:
+"""Get Selected frames in a layer.
+
+ Args:
+ full: Always get the selection range, even on a non anim/ctg layer
+
+ Returns:
+ frame: the start frame of the selection
+ count: the number of frames in the selection
+
+ Bug:
+ The official documentation states that this functions selects the layer frames, it does not, it simply
+ returns the frames selected. This will also return all frames in the layer even if they are not selected if the
+ argument `full` is set to True. We advise using `tv_layer_select` to select your frames and only using this
+ function to get the selected frames.
+ """
+ args=["full"]iffullelse[]
+ res=send_cmd("tv_layerSelectInfo",*args)
+ frame,count=tuple(map(int,res.split(" ")))
+ returnframe,count
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
330
+331
+332
deftv_layer_create(name:str)->int:
+"""Create a new image layer with the given name."""
+ returnint(send_cmd("tv_LayerCreate",name,handle_string=False))
+
Duplicate the current layer and make it the current one.
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
335
+336
+337
deftv_layer_duplicate(name:str)->int:
+"""Duplicate the current layer and make it the current one."""
+ returnint(send_cmd("tv_LayerDuplicate",name,handle_string=False))
+
Set the current layer density (opacity ranging from 0 to 100).
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
371
+372
+373
deftv_layer_density_set(new_density:int)->None:
+"""Set the current layer density (opacity ranging from 0 to 100)."""
+ send_cmd("tv_LayerDensity",new_density)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_display_get(layer_id:int)->bool:
+"""Get the visibility of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd("tv_LayerDisplay",layer_id,error_values=[0])
+ returntv_cast_to_type(res.lower(),bool)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_lock_get(layer_id:int)->bool:
+"""Get the lock state of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd("tv_LayerLock",layer_id,error_values=[GrgErrorValue.ERROR])
+ returntv_cast_to_type(res.lower(),bool)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_lock_set(layer_id:int,new_state:bool)->None:
+"""Set the lock state of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd(
+ "tv_LayerLock",
+ layer_id,
+ int(new_state),
+ error_values=[GrgErrorValue.ERROR],
+ )
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_collapse_get(layer_id:int)->bool:
+"""Get the collapse mode of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ returnbool(int(send_cmd("tv_LayerCollapse",layer_id,error_values=[-2])))
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_collapse_set(layer_id:int,new_state:bool)->None:
+"""Set the collapse mode of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd("tv_LayerCollapse",layer_id,int(new_state),error_values=[-2])
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_blending_mode_get(layer_id:int)->BlendingMode:
+"""Get the blending mode of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd("tv_LayerBlendingMode",layer_id)
+ returntv_cast_to_type(res.lower(),BlendingMode)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_blending_mode_set(layer_id:int,mode:BlendingMode)->None:
+"""Set the blending mode of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd("tv_LayerBlendingMode",layer_id,mode.value)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_stencil_get(layer_id:int)->StencilMode:
+"""Get the stencil state and mode of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd("tv_LayerStencil",layer_id)
+ _,state,mode=res.split(" ")
+
+ ifstate=="off":
+ returnStencilMode.OFF
+
+ returntv_cast_to_type(mode,StencilMode)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_stencil_set(layer_id:int,mode:StencilMode)->None:
+"""Set the stencil state and mode of the given layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ ifmode==StencilMode.OFF:
+ args=["off"]
+ elifmode==StencilMode.ON:
+ args=["on"]
+ else:
+ args=["on",mode.value]
+
+ send_cmd("tv_LayerStencil",layer_id,*args)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_show_thumbnails_get(
+ layer_id:int,
+)->bool:
+"""Get the show thumbnails state for a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd(
+ "tv_LayerShowThumbnails",layer_id,error_values=[GrgErrorValue.ERROR]
+ )
+ returnres=="1"
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_auto_break_instance_get(layer_id:int)->bool:
+"""Get the layer auto break instance value for a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd("tv_LayerAutoBreakInstance",layer_id,error_values=[-1,-2,-3])
+ returnres=="1"
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_auto_create_instance_get(
+ layer_id:int,
+)->bool:
+"""Get the layer auto create instance value for a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd("tv_LayerAutoCreateInstance",layer_id,error_values=[-1,-2,-3])
+ returnres=="1"
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_auto_create_instance_set(
+ layer_id:int,
+ state:bool,
+)->None:
+"""Set the layer auto create instance value for a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd(
+ "tv_LayerAutoCreateInstance",layer_id,int(state),error_values=[-1,-2,-3]
+ )
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_pre_behavior_get(layer_id:int)->LayerBehavior:
+"""Get the pre-behavior value for a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd("tv_LayerPreBehavior",layer_id)
+ returntv_cast_to_type(res,LayerBehavior)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_pre_behavior_set(layer_id:int,behavior:LayerBehavior)->None:
+"""Set the pre-behavior value for a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd("tv_LayerPreBehavior",layer_id,behavior.value)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_post_behavior_get(layer_id:int)->LayerBehavior:
+"""Get the post-behavior value for a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd("tv_LayerPostBehavior",layer_id)
+ returntv_cast_to_type(res,LayerBehavior)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_post_behavior_set(layer_id:int,behavior:LayerBehavior)->None:
+"""Set the post-behavior value for a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd("tv_LayerPostBehavior",layer_id,behavior.value)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_lock_position_get(layer_id:int)->bool:
+"""Get the lock position state of a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd("tv_LayerLockPosition",layer_id)
+ returntv_cast_to_type(res,bool)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_lock_position_set(layer_id:int,state:bool)->None:
+"""Set the lock position state of a layer.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd("tv_LayerLockPosition",layer_id,int(state))
+
Get the preserve transparency state of the current layer.
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
721
+722
+723
+724
+725
deftv_preserve_get()->LayerTransparency:
+"""Get the preserve transparency state of the current layer."""
+ res=send_cmd("tv_Preserve")
+ _,state=res.split(" ")
+ returntv_cast_to_type(state,LayerTransparency)
+
Set the preserve transparency state of the current layer.
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
728
+729
+730
deftv_preserve_set(state:LayerTransparency)->None:
+"""Set the preserve transparency state of the current layer."""
+ send_cmd("tv_Preserve","alpha",state.value)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_mark_get(layer_id:int,frame:int)->int:
+"""Get the mark color of a layer at a frame.
+
+ Args:
+ layer_id: the layer id
+ frame: the frame with a mark
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+
+ Returns:
+ int: the mark color index
+ """
+ returnint(send_cmd("tv_LayerMarkGet",layer_id,frame))
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_mark_set(layer_id:int,frame:int,color_index:int)->None:
+"""Set the mark of the layer's frame.
+
+ Args:
+ layer_id: the layer id
+ frame: the frame to set the mark (use 0 to remove it).
+ color_index: the mark color
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd("tv_LayerMarkSet",layer_id,frame,color_index)
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
869
+870
+871
+872
+873
+874
+875
+876
deftv_layer_shift(layer_id:int,start:int)->None:
+"""Move the layer to a new frame.
+
+ Args:
+ layer_id: layer id
+ start: frame to shift layer to
+ """
+ send_cmd("tv_LayerShift",layer_id,start)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_load_dependencies(layer_id:int)->None:
+"""Load all dependencies of the given layer in memory.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd("tv_LayerLoadDependencies",layer_id)
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_color_set_color(
+ clip_id:int,
+ color_index:int,
+ color:RGBColor,
+ name:str|None=None,
+)->None:
+"""Set a specific colors information in the clips color list.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+
+ Note:
+ The color with index 0 is the "Default" color, and it can't be changed
+ """
+ args:list[Any]=[
+ LayerColorAction.SETCOLOR.value,
+ clip_id,
+ color_index,
+ color.r,
+ color.g,
+ color.b,
+ ]
+
+ ifname:
+ args.append(name)
+
+ send_cmd("tv_LayerColor",*args,error_values=[GrgErrorValue.ERROR])
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_color_get(layer_id:int)->int:
+"""Get the layer's color index from the clips color list.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ res=send_cmd(
+ "tv_LayerColor",
+ LayerColorAction.GET.value,
+ layer_id,
+ error_values=[-1],
+ )
+ returnint(res)
+
@try_cmd(raise_exc=NoObjectWithIdError)
+deftv_layer_color_set(layer_id:int,color_index:int)->None:
+"""Set the layer's color index from the clips color list.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ send_cmd(
+ "tv_LayerColor",
+ LayerColorAction.SET.value,
+ layer_id,
+ color_index,
+ error_values=[-1],
+ )
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
981
+982
+983
+984
+985
+986
+987
+988
+989
+990
deftv_layer_color_lock(color_index:int)->int:
+"""Lock all layers that use the given color index.
+
+ Args:
+ color_index: the layer color index
+
+ Returns:
+ the number of layers locked
+ """
+ returnint(send_cmd("tv_LayerColor",LayerColorAction.LOCK.value,color_index))
+
deftv_layer_color_unlock(color_index:int)->int:
+"""Unlock all layers that use the given color index.
+
+ Args:
+ color_index: the layer color index
+
+ Returns:
+ the number of unlocked layers
+ """
+ returnint(send_cmd("tv_LayerColor",LayerColorAction.UNLOCK.value,color_index))
+
deftv_layer_color_show(mode:LayerColorDisplayOpt,color_index:int)->int:
+"""Show all layers that use the given color index.
+
+ Args:
+ mode: the display mode
+ color_index: the layer color index
+
+ Returns:
+ the number of unlocked layers
+ """
+ res=send_cmd(
+ "tv_LayerColor",
+ LayerColorAction.SHOW.value,
+ mode.value,
+ color_index,
+ error_values=[GrgErrorValue.ERROR],
+ )
+ returnint(res)
+
deftv_layer_color_hide(mode:LayerColorDisplayOpt,color_index:int)->int:
+"""Hide all layers that use the given color index.
+
+ Args:
+ mode: the display mode
+ color_index: the layer color index
+
+ Returns:
+ the number of unlocked layers
+ """
+ returnint(
+ send_cmd(
+ "tv_LayerColor",
+ LayerColorAction.HIDE.value,
+ mode.value,
+ color_index,
+ error_values=[GrgErrorValue.ERROR],
+ )
+ )
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id",
+)
+deftv_layer_color_visible(color_index:int)->bool:
+"""Get the visibility of the color index (2px height) in the timeline.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ returnbool(
+ send_cmd(
+ "tv_LayerColor",
+ LayerColorAction.VISIBLE.value,
+ color_index,
+ error_values=[-1],
+ )
+ )
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid color index",
+)
+deftv_layer_color_select(color_index:int)->int:
+"""Select all layers that use the given color index.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ returnint(send_cmd("tv_LayerColor",LayerColorAction.SELECT.value,color_index))
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid color index",
+)
+deftv_layer_color_unselect(color_index:int)->int:
+"""Unselect all layers that use the given color index.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id
+ """
+ returnint(send_cmd("tv_LayerColor",LayerColorAction.UNSELECT.value,color_index))
+
deftv_instance_name(
+ layer_id:int,
+ mode:InstanceNamingMode,
+ prefix:str|None=None,
+ suffix:str|None=None,
+ process:InstanceNamingProcess|None=None,
+)->None:
+"""Rename all instances.
+
+ Note:
+ The suffix can only be added when using mode InstanceNamingMode.SMART
+
+ Bug:
+ Using a wrong layer_id causes a crash
+
+ Args:
+ layer_id: the layer id
+ mode: the instance renaming mode
+ prefix: the prefix to add to each name
+ suffix: the suffix to add to each name
+ process: the instance naming process
+ """
+ args_dict:dict[str,Any]={
+ "mode":mode.value,
+ "prefix":prefix,
+ }
+
+ ifmode==InstanceNamingMode.SMART:
+ args_dict["suffix"]=suffix
+ args_dict["process"]=process.valueifprocesselseNone
+
+ args=args_dict_to_list(args_dict)
+ send_cmd("tv_InstanceName",layer_id,*args,error_values=[-1,-2])
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid layer id or the frame doesn't have an instance",
+)
+deftv_instance_get_name(layer_id:int,frame:int)->str:
+"""Get the name of an instance.
+
+ Args:
+ layer_id: the layer id
+ frame: the frame of the instance
+
+ Raises:
+ NoObjectWithIdError: if given an invalid layer id or an invalid instance frame
+
+ Returns:
+ the instance name
+ """
+ returnsend_cmd("tv_InstanceGetName",layer_id,frame).strip('"')
+
if an invalid layer id was provided or no instance was found at the given frame
+
+
+
+
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
1147
+1148
+1149
+1150
+1151
+1152
+1153
+1154
@try_cmd(exception_msg="Invalid layer id or no instance at given frame")
+deftv_instance_set_name(layer_id:int,frame:int,name:str)->str:
+"""Set the name of an instance.
+
+ Raises:
+ GeorgeError: if an invalid layer id was provided or no instance was found at the given frame
+ """
+ returnsend_cmd("tv_InstanceSetName",layer_id,frame,name)
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
1157
+1158
+1159
+1160
+1161
+1162
+1163
deftv_exposure_next()->int:
+"""Go to the next layer instance head.
+
+ Returns:
+ The next instances start frame
+ """
+ returnint(send_cmd("tv_ExposureNext"))
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
1166
+1167
+1168
+1169
+1170
+1171
+1172
deftv_exposure_break(frame:int)->None:
+"""Break a layer instance/exposure at the given frame.
+
+ Args:
+ frame: the split frame
+ """
+ send_cmd("tv_ExposureBreak",frame)
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
1175
+1176
+1177
+1178
+1179
+1180
+1181
+1182
deftv_exposure_add(frame:int,count:int)->None:
+"""Add new frames to an existing layer instance/exposure.
+
+ Args:
+ frame: the split frame
+ count: the number of frames to add
+ """
+ send_cmd("tv_ExposureAdd",frame,count)
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
1185
+1186
+1187
+1188
+1189
+1190
+1191
+1192
deftv_exposure_set(frame:int,count:int)->None:
+"""Set the number frames of an existing layer instance/exposure.
+
+ Args:
+ frame: the split frame
+ count: the number of frames to add
+ """
+ send_cmd("tv_ExposureSet",frame,count)
+
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
1195
+1196
+1197
+1198
+1199
+1200
+1201
deftv_exposure_prev()->int:
+"""Go to the previous layer instance head (*before* the current instance).
+
+ Returns:
+ The previous instances start frame
+ """
+ returnint(send_cmd("tv_ExposurePrev"))
+
@try_cmd(exception_msg="No file found or invalid format")
+deftv_save_image(export_path:Path|str)->None:
+"""Save the current image of the current layer.
+
+ Raises:
+ GeorgeError: if the file couldn't be saved or an invalid format was provided
+ """
+ export_path=Path(export_path)
+ send_cmd("tv_SaveImage",export_path.as_posix())
+
@try_cmd(exception_msg="Invalid image format")
+deftv_load_image(img_path:Path|str,stretch:bool=False)->None:
+"""Load an image in the current image layer.
+
+ Raises:
+ FileNotFoundError: if the input file doesn't exist
+ GeorgeError: if the provided file is in an invalid format
+ """
+ img_path=Path(img_path)
+
+ ifnotimg_path.exists():
+ raiseFileNotFoundError(f"File not found at: {img_path.as_posix()}")
+
+ args:list[Any]=[img_path.as_posix()]
+ ifstretch:
+ args.append("stretch")
+
+ send_cmd("tv_LoadImage",*args)
+
Clear (or fill with BPen) the current image (selection) of the current layer.
+
+
+ Source code in pytvpaint/george/grg_layer.py
+
1235
+1236
+1237
deftv_clear(fill_b_pen:bool=False)->None:
+"""Clear (or fill with BPen) the current image (selection) of the current layer."""
+ send_cmd("tv_Clear",int(fill_b_pen))
+
Returns the correct tvpaint format value from a string extension.
+
+
+ Source code in pytvpaint/george/grg_base.py
+
340
+341
+342
+343
+344
+345
+346
+347
+348
@classmethod
+deffrom_extension(cls,extension:str)->SaveFormat:
+"""Returns the correct tvpaint format value from a string extension."""
+ extension=extension.replace(".","").upper()
+ ifnothasattr(SaveFormat,extension):
+ raiseValueError(
+ f"Could not find format ({extension}) in accepted formats ({SaveFormat})"
+ )
+ returncast(SaveFormat,getattr(cls,extension.upper()))
+
Context manager that creates an undo stack. Useful to undo a sequence of George actions.
+
+
+ Source code in pytvpaint/george/grg_base.py
+
612
+613
+614
+615
+616
+617
@contextlib.contextmanager
+defundoable_stack()->Generator[None,None,None]:
+"""Context manager that creates an undo stack. Useful to undo a sequence of George actions."""
+ tv_undo_open_stack()
+ yield
+ tv_undo_close_stack()
+
+
+
+ Source code in pytvpaint/george/grg_base.py
+
657
+658
+659
+660
+661
+662
+663
+664
+665
+666
defadd_some_magic(
+ i_am_a_badass:bool=False,magic_number:int|None=None
+)->None:
+"""Don't use ! Will change your life forever..."""
+ ifnoti_am_a_badass:
+ log.warning("Sorry, you're not enough of a badass for this function...")
+
+ magic_number=magic_numberor14
+ send_cmd("tv_MagicNumber",magic_number)
+ log.info("Totally worth it, right ? ^^")
+
deftv_request(msg:str,confirm_text:str="Yes",cancel_text:str="No")->bool:
+"""Open a confirmation prompt with a message.
+
+ Args:
+ msg: the message to display
+ confirm_text: the confirm button text. Defaults to "Yes".
+ cancel_text: the cancel button text. Defaults to "No".
+
+ Returns:
+ bool: True if clicked on "Yes"
+ """
+ returnbool(int(send_cmd("tv_Request",msg,confirm_text,cancel_text)))
+
deftv_req_num(
+ value:int,min:int,max:int,title:str="Enter Value"
+)->int|None:
+"""Open a prompt to request an integer (within a range).
+
+ Args:
+ value: the initial value
+ min: the minimum value
+ max: the maximum value
+ title: title of the prompt dialog. Defaults to "Enter Value".
+
+ Returns:
+ the value or None if cancelled
+ """
+ res=send_cmd("tv_ReqNum",value,min,max,title,handle_string=False)
+ returnNoneifres.lower()=="cancel"elseint(res)
+
deftv_req_angle(
+ value:float,min:float,max:float,title:str="Enter Value"
+)->float|None:
+"""Open a prompt to request an angle (in degree).
+
+ Args:
+ value: the initial value
+ min: the minimum value
+ max: the maximum value
+ title: title of the prompt. Defaults to "Enter Value".
+
+ Returns:
+ the value or None if cancelled
+ """
+ res=send_cmd("tv_ReqAngle",value,min,max,title,handle_string=False)
+ returnNoneifres.lower()=="cancel"elsefloat(res)
+
deftv_req_float(
+ value:float,min:float,max:float,title:str="Enter value"
+)->float|None:
+"""Open a prompt to request a float.
+
+ Args:
+ value: the initial value
+ min: the minimum value
+ max: the maximum value
+ title: title of the prompt. Defaults to "Enter Value".
+
+ Returns:
+ the value or None if cancelled
+ """
+ res=send_cmd("tv_ReqFloat",value,min,max,title,handle_string=False)
+ returnNoneifres.lower()=="cancel"elsefloat(res)
+
deftv_req_string(title:str,text:str)->str|None:
+"""Open a prompt to request a string.
+
+ Args:
+ title: title of the requester. Defaults to "Enter Value".
+ text: the initial value
+
+ Returns:
+ the value or None if cancelled
+ """
+ cmd_args=["|".join([title,text])]
+ if"\n"intext:
+ cmd_args.insert(0,"multiline")
+ res=send_cmd("tv_ReqString",*cmd_args,handle_string=False)
+ returnNoneifres.lower()=="cancel"elseres
+
deftv_list_request(entries:list[Entry])->tuple[int,str]:
+"""Open a prompt to request a selection in a list.
+
+ Args:
+ entries: the list of entries (either a single entry or sub entries)
+
+ Returns:
+ the position, the entry
+ """
+ entries_str="|".join(map(_entry_to_str,entries))
+ res=send_cmd("tv_ListRequest",entries_str,error_values=["-1 Cancel"])
+ res_obj=tv_parse_list(
+ res,
+ with_fields=[
+ ("index",int),
+ ("entry",str),
+ ],
+ )
+ index,entry=tuple(res_obj.values())
+ returnint(index),entry
+
deftv_req_file(
+ mode:FileMode,
+ title:str="",
+ working_dir:Path|str|None=None,
+ default_name:str|None=None,
+ extension_filter:str|None=None,
+)->Path|None:
+"""Open a prompt to request a file.
+
+ Args:
+ mode: save or load
+ title: the title of the request
+ working_dir: the default folder to go. Defaults to None.
+ default_name: the default name. Defaults to None.
+ extension_filter: display the files with this extension. Defaults to None.
+
+ Returns:
+ the choosen path or None if cancelled
+ """
+ cmd_args=[
+ title,
+ Path(working_dir).as_posix()ifworking_direlseNone,
+ default_name,
+ extension_filter,
+ ]
+
+ arg_str="|".join([vifvisnotNoneelse""forvincmd_args])
+ res=send_cmd("tv_ReqFile",f"{mode.value}{arg_str}",handle_string=False)
+
+ returnNoneifres.lower()=="cancel"elsePath(res)
+
Copies the contents of the current image in the current layer into the buffer undo memory.
+
None of the draw commands described in this section updates this buffer memory.
+If you click on the Undo button after executing a George program, everything that the program has drawn in your image will be deleted.
+With this function you can update the undo buffer memory whenever you wish (for example at the beginning of the program).
+
+
+ Source code in pytvpaint/george/grg_base.py
+
840
+841
+842
+843
+844
+845
+846
+847
deftv_update_undo()->None:
+"""Copies the contents of the current image in the current layer into the buffer undo memory.
+
+ None of the draw commands described in this section updates this buffer memory.
+ If you click on the Undo button after executing a George program, everything that the program has drawn in your image will be deleted.
+ With this function you can update the undo buffer memory whenever you wish (for example at the beginning of the program).
+ """
+ send_cmd("tv_UpdateUndo")
+
Surround a piece of code with tv_undoopenstack ... tv_undoclosestack, then multiple undo will be added to this stack, and closing this stack will undo everything inside.
+(To be sure the script returns to the expected result use tv_updateundo before tv_undoopenstack)
+
+
+ Source code in pytvpaint/george/grg_base.py
+
850
+851
+852
+853
+854
+855
+856
deftv_undo_open_stack()->None:
+"""Open an 'undo' stack.
+
+ Surround a piece of code with tv_undoopenstack ... tv_undoclosestack, then multiple undo will be added to this stack, and closing this stack will undo everything inside.
+ (To be sure the script returns to the expected result use tv_updateundo before tv_undoopenstack)
+ """
+ send_cmd("tv_UndoOpenStack")
+
the shape specific parameters as keyword arguments
+
+
+
+ {}
+
+
+
+
+
+
+ Source code in pytvpaint/george/grg_base.py
+
970
+971
+972
+973
+974
+975
+976
+977
deftv_set_active_shape(shape:TVPShape,**shape_kwargs:Any)->None:
+"""Set the current shape and its tool parameters.
+
+ Args:
+ shape: the shape to set
+ **shape_kwargs: the shape specific parameters as keyword arguments
+ """
+ send_cmd("tv_SetActiveShape",shape.value,*args_dict_to_list(shape_kwargs))
+
+
+
+ Source code in pytvpaint/george/grg_base.py
+
1032
+1033
+1034
deftv_set_a_pen_hsl(color:HSLColor)->HSLColor:
+"""Set the A Pen HSL color."""
+ return_tv_set_ab_pen("a",color.h,color.s,color.l,color_format="hsl")
+
+
+
+ Source code in pytvpaint/george/grg_base.py
+
1037
+1038
+1039
deftv_set_b_pen_rgba(color:RGBColor,alpha:int|None=None)->RGBColor:
+"""Set the B Pen RGBA color."""
+ return_tv_set_ab_pen("b",color.r,color.g,color.b,color_format="rgb",a=alpha)
+
+
+
+ Source code in pytvpaint/george/grg_base.py
+
1042
+1043
+1044
deftv_set_b_pen_hsl(color:HSLColor)->HSLColor:
+"""Set the B Pen HSL color."""
+ return_tv_set_ab_pen("b",color.h,color.s,color.l,color_format="hsl")
+
Change current pen tool size. This function is most likely deprecated it is undocumented in the George reference but still works.
+
+
+ Source code in pytvpaint/george/grg_base.py
+
1047
+1048
+1049
+1050
deftv_pen(size:float)->float:
+"""Change current pen tool size. This function is most likely deprecated it is undocumented in the George reference but still works."""
+ res=tv_parse_dict(send_cmd("tv_Pen",size),with_fields=[("size",float)])
+ returncast(float,res["size"])
+
deftv_line(
+ xy1:tuple[int,int],
+ xy2:tuple[int,int],
+ right_click:bool=False,
+ dry:bool=False,
+)->None:
+"""Draw a line (with the current brush).
+
+ Args:
+ xy1: start position as (x, y)
+ xy2: end position as (x, y)
+ right_click: True to emulate right click, False to emulate left click. Default is False
+ dry: True for dry mode
+ """
+ args=[
+ *xy1,
+ *xy2,
+ bool(right_click),
+ bool(dry),
+ ]
+ send_cmd("tv_Line",*args)
+
deftv_text(text:str,x:int,y:int,use_b_pen:bool=False)->None:
+"""Write text in a layer instance.
+
+ Args:
+ text: text to write
+ x: text x position
+ y: text y position
+ use_b_pen: True will use b pen, False will use A pen
+ """
+ send_cmd("tv_Text",x,y,int(use_b_pen),text)
+
deftv_rect(
+ tlx:float,
+ tly:float,
+ brx:float,
+ bry:float,
+ button:RectButton|None=None,
+)->None:
+"""Draws an unfilled rectangle.
+
+ Args:
+ tlx: top left x coordinate
+ tly: top left y coordinate
+ brx: bottom right x coordinate
+ bry: bottom right y coordinate
+ button: use left or right click button (left draws, right erases)
+ """
+ args:list[float]=[tlx,tly,brx,bry]
+ ifbutton:
+ args.append(button.value)
+ send_cmd("tv_Rect",*args)
+
deftv_background_set(
+ mode:BackgroundMode,
+ color:tuple[RGBColor,RGBColor]|RGBColor|None=None,
+)->None:
+"""Set the background mode of the project.
+
+ Args:
+ mode: color mode (None, checker or one color)
+ color: None for None mode, RBGColor for one color, and tuple of RGBColors for checker
+ """
+ args=[]
+
+ ifmode==BackgroundMode.CHECKandisinstance(color,tuple):
+ c1,c2=color
+ args=[c1.r,c1.g,c1.b,c2.r,c2.g,c2.b]
+ elifmode==BackgroundMode.COLORandisinstance(color,RGBColor):
+ args=[color.r,color.g,color.b]
+
+ send_cmd("tv_Background",mode.value,*args)
+
@try_cmd(exception_msg="Invalid format")
+deftv_load_project(project_path:Path|str,silent:bool=False)->str:
+"""Load a file as a project if possible or open Import panel.
+
+ Raises:
+ FileNotFoundError: if the project file doesn't exist
+ GeorgeError: if the provided file is in an invalid format
+ """
+ project_path=Path(project_path)
+
+ ifnotproject_path.exists():
+ raiseFileNotFoundError(f"Project not found at: {project_path.as_posix()}")
+
+ args:list[Any]=[project_path.as_posix()]
+
+ ifsilent:
+ args.extend(["silent",int(silent)])
+
+ returnsend_cmd("tv_LoadProject",*args,error_values=[-1])
+
+
+
+ Source code in pytvpaint/george/grg_project.py
+
149
+150
+151
+152
+153
+154
+155
+156
+157
+158
deftv_save_project(project_path:Path|str)->None:
+"""Save the current project as tvpp."""
+ project_path=Path(project_path)
+ parent=project_path.parent
+
+ ifnotparent.exists():
+ msg=f"Can't save because parent folder does not exist: {parent.as_posix()}"
+ raiseValueError(msg)
+
+ send_cmd("tv_SaveProject",project_path.as_posix())
+
+
+
+ Source code in pytvpaint/george/grg_project.py
+
161
+162
+163
+164
+165
+166
+167
+168
@try_cmd(exception_msg="Can't duplicate the current project")
+deftv_project_duplicate()->None:
+"""Duplicate the current project.
+
+ Raises:
+ GeorgeError: if an error occurred during the project creation.
+ """
+ send_cmd("tv_ProjectDuplicate",error_values=[0])
+
+
+
+ Source code in pytvpaint/george/grg_project.py
+
171
+172
+173
+174
+175
+176
+177
+178
@try_cmd(exception_msg="No project at provided position")
+deftv_project_enum_id(position:int)->str:
+"""Get the id of the project at the given position.
+
+ Raises:
+ GeorgeError: if no project found at the provided position.
+ """
+ returnsend_cmd("tv_ProjectEnumId",position,error_values=[GrgErrorValue.NONE])
+
@try_cmd(
+ raise_exc=NoObjectWithIdError,
+ exception_msg="Invalid project id",
+)
+deftv_project_info(project_id:str)->TVPProject:
+"""Get info of the given project.
+
+ Raises:
+ NoObjectWithIdError: if given an invalid project id
+ """
+ result=send_cmd("tv_ProjectInfo",project_id,error_values=[GrgErrorValue.EMPTY])
+ project=tv_parse_list(result,with_fields=TVPProject)
+ project["id"]=project_id
+ returnTVPProject(**project)
+
creates a resized copy of the project with a new id
+
+
+ Source code in pytvpaint/george/grg_project.py
+
217
+218
+219
+220
+221
+222
+223
deftv_resize_project(width:int,height:int)->None:
+"""Resize the current project.
+
+ Note:
+ creates a resized copy of the project with a new id
+ """
+ send_cmd("tv_ResizeProject",width,height)
+
Create a new resized project and close the current one.
+
+
+ Source code in pytvpaint/george/grg_project.py
+
226
+227
+228
deftv_resize_page(width:int,height:int,resize_opt:ResizeOption)->None:
+"""Create a new resized project and close the current one."""
+ send_cmd("tv_ResizePage",width,height,resize_opt.value)
+
+
+
+ Source code in pytvpaint/george/grg_project.py
+
241
+242
+243
+244
+245
+246
+247
deftv_ratio()->float:
+"""Get the current project pixel aspect ratio.
+
+ Bug:
+ Doesn't work and always returns an empty string
+ """
+ returnfloat(send_cmd("tv_GetRatio",error_values=[GrgErrorValue.EMPTY]))
+
deftv_project_render_camera(project_id:str)->str:
+"""Render the given project's camera view to a new project.
+
+ Returns:
+ the new project id
+ """
+ returnsend_cmd(
+ "tv_ProjectRenderCamera",
+ project_id,
+ error_values=[GrgErrorValue.ERROR],
+ )
+
+
+
+ Source code in pytvpaint/george/grg_project.py
+
316
+317
+318
+319
+320
+321
deftv_frame_rate_project_set(frame_rate:float,time_stretch:bool=False)->None:
+"""Set the framerate of the current project."""
+ args:list[Any]=[frame_rate]
+ iftime_stretch:
+ args.append("timestretch")
+ send_cmd("tv_FrameRate",*args)
+
+
+
+ Source code in pytvpaint/george/grg_project.py
+
324
+325
+326
deftv_frame_rate_preview_set(frame_rate:float)->None:
+"""Set the framerate of the preview (playback)."""
+ send_cmd("tv_FrameRate",frame_rate,"preview")
+
+
+
+ Source code in pytvpaint/george/grg_project.py
+
334
+335
+336
+337
+338
+339
+340
deftv_project_current_frame_set(frame:int)->int:
+"""Set the current frame of the current project.
+
+ Note:
+ this is relative to the current clip markin
+ """
+ returnint(send_cmd("tv_ProjectCurrentFrame",frame))
+
+
+
+ Source code in pytvpaint/george/grg_project.py
+
343
+344
+345
+346
+347
+348
+349
+350
+351
+352
deftv_load_palette(palette_path:Path|str)->None:
+"""Load a palette(s) from a file/directory.
+
+ Raises:
+ FileNotFoundError: if palette was not found at the provided path
+ """
+ palette_path=Path(palette_path)
+ ifnotpalette_path.exists():
+ raiseFileNotFoundError(f"Palette not found at: {palette_path.as_posix()}")
+ send_cmd("tv_LoadPalette",palette_path.as_posix())
+
+
+
+ Source code in pytvpaint/george/grg_project.py
+
391
+392
+393
+394
+395
+396
+397
deftv_sound_project_new(sound_path:Path|str)->None:
+"""Add a new soundtrack to the current project."""
+ path=Path(sound_path)
+ ifnotpath.exists():
+ raiseValueError(f"Sound file not found at : {path.as_posix()}")
+
+ send_cmd("tv_SoundProjectNew",path.as_posix(),error_values=[-1,-3,-4])
+
+
+
+ Source code in pytvpaint/george/grg_project.py
+
400
+401
+402
deftv_sound_project_remove(track_index:int)->None:
+"""Remove a soundtrack from the current project."""
+ send_cmd("tv_SoundProjectRemove",track_index,error_values=[-2])
+
+
+
+ Source code in pytvpaint/george/grg_scene.py
+
9
+10
+11
+12
+13
+14
+15
+16
@try_cmd(exception_msg="No scene at provided position")
+deftv_scene_enum_id(position:int)->int:
+"""Get the id of the scene at the given position in the current project.
+
+ Raises:
+ GeorgeError: if no scene found at the provided position
+ """
+ returnint(send_cmd("tv_SceneEnumId",position,error_values=[GrgErrorValue.NONE]))
+
Makes the parent clip the current one, thereby making sure the correct camera will be set.
+
+
+ Source code in pytvpaint/camera.py
+
47
+48
+49
defmake_current(self)->None:
+"""Makes the parent clip the current one, thereby making sure the correct camera will be set."""
+ self._clip.make_current()
+
@set_as_current
+definsert_point(
+ self,
+ index:int,
+ x:int,
+ y:int,
+ angle:int,
+ scale:float,
+)->CameraPoint:
+"""Insert a new point in the camera path."""
+ returnCameraPoint.new(self,index,x,y,angle,scale)
+
Get the points data interpolated at that position (between 0 and 1).
+
+
+ Source code in pytvpaint/camera.py
+
145
+146
+147
+148
+149
@set_as_current
+defget_point_data_at(self,position:float)->george.TVPCameraPoint:
+"""Get the points data interpolated at that position (between 0 and 1)."""
+ position=max(0.0,min(position,1.0))
+ returngeorge.tv_camera_interpolation(position)
+
@set_as_current
+defremove_point(self,index:int)->None:
+"""Remove a point at that index."""
+ try:
+ point=next(pfori,pinenumerate(self.points)ifi==index)
+ point.remove()
+ exceptStopIteration:
+ pass
+
defrefresh(self)->None:
+"""Refreshed the camera point data."""
+ super().refresh()
+ ifnotself.refresh_on_callandself._data:
+ return
+ self._data=george.tv_camera_enum_points(self._index)
+
@classmethod
+defnew(
+ cls,
+ camera:Camera,
+ index:int,
+ x:int,
+ y:int,
+ angle:int,
+ scale:float,
+)->CameraPoint:
+"""Create a new point and add it to the camera path at that index."""
+ george.tv_camera_insert_point(index,x,y,angle,scale)
+ returncls(index,camera)
+
the point instance won't be usable after that call
+
+
+ Source code in pytvpaint/camera.py
+
290
+291
+292
+293
+294
+295
+296
+297
defremove(self)->None:
+"""Remove the camera point.
+
+ Warning:
+ the point instance won't be usable after that call
+ """
+ george.tv_camera_remove_point(self.index)
+ self.mark_removed()
+
def__init__(
+ self,
+ clip_id:int,
+ project:Project|None=None,
+)->None:
+"""Constructs a Clip from an existing TVPaint clip (giving its id).
+
+ Note:
+ You should use `Clip.new` to create a new clip
+
+ Args:
+ clip_id: an existing clip id
+ project: the project or the current one if None
+ """
+ frompytvpaint.projectimportProject
+
+ super().__init__()
+ self._id=clip_id
+ self._project=projectorProject.current_project()
+ self._data=george.tv_clip_info(self.id)
+
@classmethod
+defnew(
+ cls,
+ name:str,
+ scene:Scene|None=None,
+ project:Project|None=None,
+)->Clip:
+"""Creates a new clip.
+
+ Args:
+ name: the new clip name
+ scene: the scene or the current one if None. Defaults to None.
+ project: the project or the current one if None. Defaults to None.
+
+ Returns:
+ Clip: the newly created clip
+ """
+ frompytvpaint.projectimportProject
+
+ project=projectorProject.current_project()
+ project.make_current()
+
+ scene=sceneorproject.current_scene
+ scene.make_current()
+
+ name=utils.get_unique_name(project.clip_names,name)
+ george.tv_clip_new(name)
+
+ returnClip.current_clip()
+
defmake_current(self)->None:
+"""Make the clip the current one."""
+ ifgeorge.tv_clip_current_id()==self.id:
+ return
+ george.tv_clip_select(self.id)
+
The end frame of the clip relative to the project's timeline.
+
+
+ Source code in pytvpaint/clip.py
+
200
+201
+202
+203
+204
+205
+206
@refreshed_property
+deftimeline_end(self)->int:
+"""The end frame of the clip relative to the project's timeline."""
+ clip_start=self.mark_inorself.start
+ clip_end=self.mark_outorself.end
+ clip_duration=clip_end-clip_start
+ returnself.timeline_start+clip_duration
+
@set_as_current
+defduplicate(self)->Clip:
+"""Duplicates the clip.
+
+ Note:
+ a new unique name is choosen for the duplicated clip with `get_unique_name`.
+ """
+ george.tv_clip_duplicate(self.id)
+ new_clip=self.project.current_clip
+ new_clip.name=utils.get_unique_name(self.project.clip_names,new_clip.name)
+ returnnew_clip
+
the instance is not usable after that call because it's marked as removed.
+
+
+ Source code in pytvpaint/clip.py
+
314
+315
+316
+317
+318
+319
+320
+321
defremove(self)->None:
+"""Removes the clip.
+
+ Warning:
+ the instance is not usable after that call because it's marked as removed.
+ """
+ george.tv_clip_close(self.id)
+ self.mark_removed()
+
defget_layer(
+ self,
+ by_id:int|None=None,
+ by_name:str|None=None,
+)->Layer|None:
+"""Get a specific layer by id or name."""
+ returnutils.get_tvp_element(self.layers,by_id,by_name)
+
@set_as_current
+@george.undoable
+defload_media(
+ self,
+ media_path:Path,
+ start_count:tuple[int,int]|None=None,
+ stretch:bool=False,
+ time_stretch:bool=False,
+ preload:bool=False,
+ with_name:str="",
+ field_order:george.FieldOrder=george.FieldOrder.LOWER,
+)->Layer:
+"""Loads a media (single frame, video, ...) into a new Layer in the clip.
+
+ Args:
+ media_path: the path of the media. If it's a file sequence, give the path of the first image.
+ start_count: the start and number of image of sequence to load. Defaults to None.
+ stretch: Stretch each image to the size of the layer. Defaults to None.
+ time_stretch: Once loaded, the layer will have a new number of image corresponding to the project framerate. Defaults to None.
+ preload: Load all the images in memory, no more reference on the files. Defaults to None.
+ with_name: the name of the new layer
+ field_order: the field order. Defaults to None.
+
+ Returns:
+ Layer: the new layer created
+ """
+ media_path=Path(media_path)
+
+ george.tv_load_sequence(
+ media_path,
+ start_count,
+ field_order,
+ stretch,
+ time_stretch,
+ preload,
+ )
+
+ new_layer=Layer.current_layer()
+ new_layer.name=with_nameormedia_path.stem
+
+ returnnew_layer
+
if the render failed and no files were found on disk or missing frames
+
+
+
+
+
+
+
+ Note
+
This functions uses the clip's range as a basis (start-end). This is different from a project range, which
+uses the project timeline. For more details on the differences in frame ranges and the timeline in TVPaint,
+please check the Usage/Rendering section of the documentation.
+
+
+ Warning
+
Even tough pytvpaint does a pretty good job of correcting the frame ranges for rendering, we're still
+encountering some weird edge cases where TVPaint will consider the range invalid for seemingly no reason.
@set_as_current
+defrender(
+ self,
+ output_path:Path|str|FileSequence,
+ start:int|None=None,
+ end:int|None=None,
+ use_camera:bool=False,
+ layer_selection:list[Layer]|None=None,
+ alpha_mode:george.AlphaSaveMode=george.AlphaSaveMode.PREMULTIPLY,
+ background_mode:george.BackgroundMode|None=None,
+ format_opts:list[str]|None=None,
+)->None:
+"""Render the clip to a single frame or frame sequence or movie.
+
+ Args:
+ output_path: a single file or file sequence pattern
+ start: the start frame to render or the mark in or the clip's start if None. Defaults to None.
+ end: the end frame to render or the mark out or the clip's end if None. Defaults to None.
+ use_camera: use the camera for rendering, otherwise render the whole canvas. Defaults to False.
+ layer_selection: list of layers to render, if None render all of them. Defaults to None.
+ alpha_mode: the alpha mode for rendering. Defaults to george.AlphaSaveMode.PREMULTIPLY.
+ background_mode: the background mode for rendering. Defaults to None.
+ format_opts: custom format options. Defaults to None.
+
+ Raises:
+ ValueError: if requested range (start-end) not in clip range/bounds
+ ValueError: if output is a movie, and it's duration is equal to 1 frame
+ FileNotFoundError: if the render failed and no files were found on disk or missing frames
+
+ Note:
+ This functions uses the clip's range as a basis (start-end). This is different from a project range, which
+ uses the project timeline. For more details on the differences in frame ranges and the timeline in TVPaint,
+ please check the `Usage/Rendering` section of the documentation.
+
+ Warning:
+ Even tough pytvpaint does a pretty good job of correcting the frame ranges for rendering, we're still
+ encountering some weird edge cases where TVPaint will consider the range invalid for seemingly no reason.
+ """
+ default_start=self.mark_inorself.start
+ default_end=self.mark_outorself.end
+
+ self._render(
+ output_path,
+ default_start,
+ default_end,
+ start,
+ end,
+ use_camera,
+ layer_selection=layer_selection,
+ alpha_mode=alpha_mode,
+ background_mode=background_mode,
+ format_opts=format_opts,
+ )
+
@set_as_current
+defexport_tvp(self,export_path:Path|str)->None:
+"""Exports the clip in .tvp format which can be imported as a project in TVPaint.
+
+ Raises:
+ ValueError: if output extension is not (.tvp)
+ FileNotFoundError: if the render failed and no files were found on disk
+ """
+ export_path=Path(export_path)
+
+ ifexport_path.suffix!=".tvp":
+ raiseValueError("The file extension must be .tvp")
+
+ export_path.parent.mkdir(exist_ok=True,parents=True)
+ george.tv_save_clip(export_path)
+
+ ifnotexport_path.exists():
+ raiseFileNotFoundError(
+ f"Could not find output at : {export_path.as_posix()}"
+ )
+
@set_as_current
+defexport_json(
+ self,
+ export_path:Path|str,
+ save_format:george.SaveFormat,
+ folder_pattern:str=r"[%3li] %ln",
+ file_pattern:str=r"[%3ii] %ln",
+ layer_selection:list[Layer]|None=None,
+ alpha_mode:george.AlphaSaveMode=george.AlphaSaveMode.PREMULTIPLY,
+ background_mode:george.BackgroundMode|None=None,
+ format_opts:list[str]|None=None,
+ all_images:bool=False,
+ ignore_duplicates:bool=False,
+)->None:
+"""Exports the instances (or all the images) of layers in the clip and a JSON file describing the structure of that clip.
+
+ Args:
+ export_path: the JSON export path
+ save_format: file format to use for rendering
+ folder_pattern: the folder name pattern (%li: layer index, %ln: layer name, %fi: file index (added in 11.0.8)). Defaults to None.
+ file_pattern: the file name pattern (%li: layer index, %ln: layer name, %ii: image index, %in: image name, %fi: file index (added in 11.0.8)). Defaults to None.
+ layer_selection: list of layers to render or all if None. Defaults to None.
+ alpha_mode: the export alpha mode. Defaults to george.AlphaSaveMode.PREMULTIPLY.
+ background_mode: the export background mode. Defaults to None.
+ format_opts: custom format options. Defaults to None.
+ all_images: export all images (not only the instances). Defaults to False.
+ ignore_duplicates: Ignore duplicates images. Defaults to None.
+
+ Raises:
+ FileNotFoundError: if the export failed and no files were found on disk
+ """
+ export_path=Path(export_path)
+ export_path.parent.mkdir(exist_ok=True,parents=True)
+
+ fill_background=bool(
+ background_modenotin[None,george.BackgroundMode.NONE]
+ )
+
+ withutils.render_context(
+ alpha_mode,background_mode,save_format,format_opts,layer_selection
+ ):
+ george.tv_clip_save_structure_json(
+ export_path,
+ save_format,
+ fill_background=fill_background,
+ folder_pattern=folder_pattern,
+ file_pattern=file_pattern,
+ visible_layers_only=True,
+ all_images=all_images,
+ ignore_duplicates=ignore_duplicates,
+ )
+
+ ifnotexport_path.exists():
+ raiseFileNotFoundError(
+ f"Could not find output at : {export_path.as_posix()}"
+ )
+
@set_as_current
+defexport_psd(
+ self,
+ export_path:Path|str,
+ mode:george.PSDSaveMode,
+ start:int|None=None,
+ end:int|None=None,
+ layer_selection:list[Layer]|None=None,
+ alpha_mode:george.AlphaSaveMode=george.AlphaSaveMode.PREMULTIPLY,
+ background_mode:george.BackgroundMode|None=None,
+ format_opts:list[str]|None=None,
+)->None:
+"""Save the current clip as a PSD.
+
+ Args:
+ export_path: the PSD save path
+ mode: whether to save all the images, only the instances or inside the markin
+ start: the start frame. Defaults to None.
+ end: the end frame. Defaults to None.
+ layer_selection: layers to render. Defaults to None (render all the layers).
+ alpha_mode: the alpha save mode. Defaults to george.AlphaSaveMode.PREMULTIPLY.
+ background_mode: the export background mode. Defaults to None.
+ format_opts: custom format options. Defaults to None.
+
+ Raises:
+ FileNotFoundError: if the export failed and no files were found on disk
+ """
+ start=startorself.mark_inorself.start
+ end=endorself.mark_outorself.end
+
+ export_path=Path(export_path)
+ image=startifmode==george.PSDSaveMode.IMAGEelseNone
+
+ withutils.render_context(
+ alpha_mode,
+ background_mode,
+ george.SaveFormat.PSD,
+ format_opts,
+ layer_selection,
+ ):
+ george.tv_clip_save_structure_psd(
+ export_path,
+ mode,
+ image=image,
+ mark_in=start,
+ mark_out=end,
+ )
+
+ ifmode==george.PSDSaveMode.MARKIN:
+ # raises error if sequence not found
+ check_path=export_path.with_suffix(f".#{export_path.suffix}").as_posix()
+ assertFileSequence.findSequenceOnDisk(check_path)
+ else:
+ ifnotexport_path.exists():
+ raiseFileNotFoundError(
+ f"Could not find output at : {export_path.as_posix()}"
+ )
+
@set_as_current
+defexport_csv(
+ self,
+ export_path:Path|str,
+ save_format:george.SaveFormat,
+ all_images:bool=False,
+ exposure_label:str="",
+ layer_selection:list[Layer]|None=None,
+ alpha_mode:george.AlphaSaveMode=george.AlphaSaveMode.PREMULTIPLY,
+ background_mode:george.BackgroundMode|None=None,
+ format_opts:list[str]|None=None,
+)->None:
+"""Save the current clip as a CSV.
+
+ Args:
+ export_path: the .csv export path
+ save_format: file format to use for rendering
+ all_images: export all images or only instances. Defaults to None.
+ exposure_label: give a label when the image is an exposure. Defaults to None.
+ layer_selection: layers to render. Defaults to None (render all the layers).
+ alpha_mode: the alpha save mode. Defaults to george.AlphaSaveMode.PREMULTIPLY.
+ background_mode: the export background mode. Defaults to None.
+ format_opts: custom format options. Defaults to None.
+
+ Raises:
+ ValueError: if the extension is not .csv
+ FileNotFoundError: if the render failed and no files were found on disk
+ """
+ export_path=Path(export_path)
+
+ ifexport_path.suffix!=".csv":
+ raiseValueError("Export path must have .csv extension")
+
+ withutils.render_context(
+ alpha_mode,background_mode,save_format,format_opts,layer_selection
+ ):
+ george.tv_clip_save_structure_csv(export_path,all_images,exposure_label)
+
+ ifnotexport_path.exists():
+ raiseFileNotFoundError(
+ f"Could not find output at : {export_path.as_posix()}"
+ )
+
@set_as_current
+defexport_sprites(
+ self,
+ export_path:Path|str,
+ layout:george.SpriteLayout|None=None,
+ space:int=0,
+ layer_selection:list[Layer]|None=None,
+ alpha_mode:george.AlphaSaveMode=george.AlphaSaveMode.PREMULTIPLY,
+ background_mode:george.BackgroundMode|None=None,
+ format_opts:list[str]|None=None,
+)->None:
+"""Save the current clip as sprites in one image.
+
+ Args:
+ export_path (Path | str): _description_
+ layout: the sprite layout. Defaults to None.
+ space: the space between each sprite in the image. Defaults to None.
+ layer_selection: layers to render. Defaults to None (render all the layers).
+ alpha_mode: the alpha save mode. Defaults to george.AlphaSaveMode.PREMULTIPLY.
+ background_mode: the export background mode. Defaults to None.
+ format_opts: custom format options. Defaults to None.
+
+ Raises:
+ FileNotFoundError: if the export failed and no files were found on disk
+ """
+ export_path=Path(export_path)
+ save_format=george.SaveFormat.from_extension(export_path.suffix)
+
+ withutils.render_context(
+ alpha_mode,background_mode,save_format,format_opts,layer_selection
+ ):
+ george.tv_clip_save_structure_sprite(export_path,layout,space)
+
+ ifnotexport_path.exists():
+ raiseFileNotFoundError(
+ f"Could not find output at : {export_path.as_posix()}"
+ )
+
@set_as_current
+defexport_flix(
+ self,
+ export_path:Path|str,
+ start:int|None=None,
+ end:int|None=None,
+ import_parameters:str="",
+ file_parameters:str="",
+ send:bool=False,
+ layer_selection:list[Layer]|None=None,
+ alpha_mode:george.AlphaSaveMode=george.AlphaSaveMode.PREMULTIPLY,
+ background_mode:george.BackgroundMode|None=None,
+ format_opts:list[str]|None=None,
+)->None:
+"""Save the current clip for Flix.
+
+ Args:
+ export_path: the .xml export path
+ start: the start frame. Defaults to None.
+ end: the end frame. Defaults to None.
+ import_parameters: the attribute(s) of the global <flixImport> tag (waitForSource/...). Defaults to None.
+ file_parameters: the attribute(s) of each <image> (file) tag (dialogue/...). Defaults to None.
+ send: open a browser with the prefilled url. Defaults to None.
+ layer_selection: layers to render. Defaults to None (render all the layers).
+ alpha_mode: the alpha save mode. Defaults to george.AlphaSaveMode.PREMULTIPLY.
+ background_mode: the export background mode. Defaults to None.
+ format_opts: custom format options. Defaults to None.
+
+ Raises:
+ ValueError: if the extension is not .xml
+ FileNotFoundError: if the export failed and no files were found on disk
+ """
+ export_path=Path(export_path)
+
+ ifexport_path.suffix!=".xml":
+ raiseValueError("Export path must have .xml extension")
+
+ original_file=self.project.path
+ import_parameters=(
+ import_parameters
+ or'waitForSource="1" multipleSetups="1" replaceSelection="0"'
+ )
+
+ # The project needs to be saved
+ self.project.save()
+
+ # save alpha mode and save format values
+ withutils.render_context(
+ alpha_mode,background_mode,None,format_opts,layer_selection
+ ):
+ george.tv_clip_save_structure_flix(
+ export_path,
+ start,
+ end,
+ import_parameters,
+ file_parameters,
+ send,
+ original_file,
+ )
+
+ ifnotexport_path.exists():
+ raiseFileNotFoundError(
+ f"Could not find output at : {export_path.as_posix()}"
+ )
+
defset_layer_color(self,layer_color:LayerColor)->None:
+"""Set the layer color at the provided index.
+
+ Args:
+ layer_color: the layer color instance.
+ """
+ george.tv_layer_color_set_color(
+ self.id,layer_color.index,layer_color.color,layer_color.name
+ )
+
defget_layer_color(
+ self,
+ by_index:int|None=None,
+ by_name:str|None=None,
+)->LayerColor|None:
+"""Get a layer color by index or name.
+
+ Raises:
+ ValueError: if none of the arguments `by_index` and `by_name` where provided
+ """
+ ifnotby_indexandby_name:
+ raiseValueError(
+ "At least one value (by_index or by_name) must be provided"
+ )
+
+ ifby_indexisnotNone:
+ returnnext(cfori,cinenumerate(self.layer_colors)ifi==by_index)
+
+ try:
+ returnnext(cforcinself.layer_colorsifc.name==by_name)
+ exceptStopIteration:
+ returnNone
+
defget_sound(
+ self,
+ by_id:int|None=None,
+ by_path:Path|str|None=None,
+)->ClipSound|None:
+"""Get a clip sound by id or by path.
+
+ Raises:
+ ValueError: if sound object could not be found in clip
+ """
+ forsoundinself.sounds:
+ if(by_idandsound.id==by_id)or(by_pathandsound.path==by_path):
+ returnsound
+
+ returnNone
+
@name.setter
+@set_as_current
+defname(self,value:str)->None:
+"""Set the layer name.
+
+ Note:
+ it uses `get_unique_name` to find a unique layer name across all the layers in the clip
+ """
+ ifvalue==self.name:
+ return
+ value=utils.get_unique_name(self.clip.layer_names,value)
+ george.tv_layer_rename(self.id,value)
+
The layer start frame according to the project's start frame.
+
+
+ Source code in pytvpaint/layer.py
+
454
+455
+456
+457
@refreshed_property
+defstart(self)->int:
+"""The layer start frame according to the project's start frame."""
+ returnself._data.first_frame+self.project.start_frame
+
The layer end frame according to the project's start frame.
+
+
+ Source code in pytvpaint/layer.py
+
459
+460
+461
+462
@refreshed_property
+defend(self)->int:
+"""The layer end frame according to the project's start frame."""
+ returnself._data.last_frame+self.project.start_frame
+
Make the layer current, it also makes the clip current.
+
+
+ Source code in pytvpaint/layer.py
+
480
+481
+482
+483
+484
+485
+486
defmake_current(self)->None:
+"""Make the layer current, it also makes the clip current."""
+ ifself.is_current:
+ return
+ ifself.clip:
+ self.clip.make_current()
+ george.tv_layer_set(self.id)
+
@set_as_current
+defshift(self,new_start:int)->None:
+"""Move the layer to a new frame."""
+ george.tv_layer_shift(self.id,new_start-self.project.start_frame)
+
@set_as_current
+defmerge(
+ self,
+ layer:Layer,
+ blending_mode:george.BlendingMode,
+ stamp:bool=False,
+ erase:bool=False,
+ keep_color_grp:bool=True,
+ keep_img_mark:bool=True,
+ keep_instance_name:bool=True,
+)->None:
+"""Merge this layer with the given one.
+
+ Args:
+ layer: the layer to merge with
+ blending_mode: the blending mode to use
+ stamp: Use stamp mode
+ erase: Remove the source layer
+ keep_color_grp: Keep the color group
+ keep_img_mark: Keep the image mark
+ keep_instance_name: Keep the instance name
+ """
+ george.tv_layer_merge(
+ layer.id,
+ blending_mode,
+ stamp,
+ erase,
+ keep_color_grp,
+ keep_img_mark,
+ keep_instance_name,
+ )
+
@staticmethod
+defmerge_all(
+ keep_color_grp:bool=True,
+ keep_img_mark:bool=True,
+ keep_instance_name:bool=True,
+)->None:
+"""Merge all the layers in the stack.
+
+ Args:
+ keep_color_grp: Keep the color group
+ keep_img_mark: Keep the image mark
+ keep_instance_name: Keep the instance name
+ """
+ george.tv_layer_merge_all(keep_color_grp,keep_img_mark,keep_instance_name)
+
@staticmethod
+@george.undoable
+defnew(
+ name:str,
+ clip:Clip|None=None,
+ color:LayerColor|None=None,
+)->Layer:
+"""Create a new layer.
+
+ Args:
+ name: the name of the new layer
+ clip: the parent clip
+ color: the layer color
+
+ Returns:
+ Layer: the new layer
+
+ Note:
+ The layer name is checked against all other layers to have a unique name using `get_unique_name`.
+ This can take a while if you have a lot of layers.
+ """
+ frompytvpaint.clipimportClip
+
+ clip=cliporClip.current_clip()
+ clip.make_current()
+
+ name=utils.get_unique_name(clip.layer_names,name)
+ layer_id=george.tv_layer_create(name)
+
+ layer=Layer(layer_id=layer_id,clip=clip)
+
+ ifcolor:
+ layer.color=color
+
+ returnlayer
+
@classmethod
+@george.undoable
+defnew_anim_layer(
+ cls,
+ name:str,
+ clip:Clip|None=None,
+ color:LayerColor|None=None,
+)->Layer:
+"""Create a new animation layer.
+
+ Args:
+ name: the name of the new layer
+ clip: the parent clip
+ color: the layer color
+
+ Returns:
+ Layer: the new animation layer
+
+ Note:
+ It activates the thumbnail visibility
+ """
+ layer=cls.new(name,clip,color)
+ layer.convert_to_anim_layer()
+ layer.thumbnails_visible=True
+ returnlayer
+
@classmethod
+@george.undoable
+defnew_background_layer(
+ cls,
+ name:str,
+ clip:Clip|None=None,
+ color:LayerColor|None=None,
+ image:Path|str|None=None,
+ stretch:bool=False,
+)->Layer:
+"""Create a new background layer with hold as pre- and post-behavior.
+
+ Args:
+ name: the name of the new layer
+ clip: the parent clip
+ color: the layer color
+ image: the background image to load
+ stretch: whether to stretch the image to fit the view
+
+ Returns:
+ Layer: the new animation layer
+ """
+ frompytvpaint.clipimportClip
+
+ clip=cliporClip.current_clip()
+ layer=cls.new(name,clip,color)
+ layer.pre_behavior=george.LayerBehavior.HOLD
+ layer.post_behavior=george.LayerBehavior.HOLD
+ layer.thumbnails_visible=True
+
+ image=Path(imageor"")
+ ifimage.is_file():
+ layer.convert_to_anim_layer()
+ layer.load_image(image,frame=clip.start,stretch=stretch)
+
+ returnlayer
+
The current instance won't be usable after this call since it will be mark removed.
+
+
+ Source code in pytvpaint/layer.py
+
819
+820
+821
+822
+823
+824
+825
+826
+827
+828
defremove(self)->None:
+"""Remove the layer from the clip.
+
+ Warning:
+ The current instance won't be usable after this call since it will be mark removed.
+ """
+ self.clip.make_current()
+ self.is_locked=False
+ george.tv_layer_kill(self.id)
+ self.mark_removed()
+
if the render failed and no files were found on disk or missing frames
+
+
+
+
+
+
+
+ Note
+
This functions uses the layer's range as a basis (start-end). This is different from a project range, which
+uses the project timeline. For more details on the differences in frame ranges and the timeline in TVPaint,
+please check the Usage/Rendering section of the documentation.
+
+
+ Warning
+
Even tough pytvpaint does a pretty good job of correcting the frame ranges for rendering, we're still
+encountering some weird edge cases where TVPaint will consider the range invalid for seemingly no reason.
@set_as_current
+defrender(
+ self,
+ output_path:Path|str|FileSequence,
+ start:int|None=None,
+ end:int|None=None,
+ use_camera:bool=False,
+ alpha_mode:george.AlphaSaveMode=george.AlphaSaveMode.PREMULTIPLY,
+ background_mode:george.BackgroundMode|None=None,
+ format_opts:list[str]|None=None,
+)->None:
+"""Render the layer to a single frame or frame sequence or movie.
+
+ Args:
+ output_path: a single file or file sequence pattern
+ start: the start frame to render the layer's start if None. Defaults to None.
+ end: the end frame to render or the layer's end if None. Defaults to None.
+ use_camera: use the camera for rendering, otherwise render the whole canvas. Defaults to False.
+ alpha_mode: the alpha mode for rendering. Defaults to george.AlphaSaveMode.PREMULTIPLY.
+ background_mode: the background mode for rendering. Defaults to None.
+ format_opts: custom format options. Defaults to None.
+
+ Raises:
+ ValueError: if requested range (start-end) not in clip range/bounds
+ ValueError: if output is a movie
+ FileNotFoundError: if the render failed and no files were found on disk or missing frames
+
+ Note:
+ This functions uses the layer's range as a basis (start-end). This is different from a project range, which
+ uses the project timeline. For more details on the differences in frame ranges and the timeline in TVPaint,
+ please check the `Usage/Rendering` section of the documentation.
+
+ Warning:
+ Even tough pytvpaint does a pretty good job of correcting the frame ranges for rendering, we're still
+ encountering some weird edge cases where TVPaint will consider the range invalid for seemingly no reason.
+ """
+ start=self.startifstartisNoneelsestart
+ end=self.endifendisNoneelseend
+ self.clip.render(
+ output_path=output_path,
+ start=start,
+ end=end,
+ use_camera=use_camera,
+ layer_selection=[self],
+ alpha_mode=alpha_mode,
+ background_mode=background_mode,
+ format_opts=format_opts,
+ )
+
@set_as_current
+defrender_instances(
+ self,
+ export_path:Path|str|FileSequence,
+ start:int|None=None,
+ end:int|None=None,
+ alpha_mode:george.AlphaSaveMode=george.AlphaSaveMode.PREMULTIPLY,
+ background_mode:george.BackgroundMode|None=None,
+ format_opts:list[str]|None=None,
+)->FileSequence:
+"""Render all layer instances in the provided range for the current layer.
+
+ Args:
+ export_path: the export path (the extension determines the output format)
+ start: the start frame to render the layer's start if None. Defaults to None.
+ end: the end frame to render or the layer's end if None. Defaults to None.
+ alpha_mode: the render alpha mode
+ background_mode: the render background mode
+ format_opts: custom output format options to pass when rendering
+
+ Raises:
+ ValueError: if requested range (start-end) not in layer range/bounds
+ ValueError: if output is a movie
+ FileNotFoundError: if the render failed or output not found on disk
+
+ Returns:
+ FileSequence: instances output sequence
+ """
+ file_sequence,start,end,is_sequence,is_image=utils.handle_output_range(
+ export_path,self.start,self.end,start,end
+ )
+
+ ifstart<self.startorend>self.end:
+ raiseValueError(
+ f"Render ({start}-{end}) not in clip range ({(self.start,self.end)})"
+ )
+ ifnotis_image:
+ raiseValueError(
+ f"Video formats ({file_sequence.extension()}) are not supported for instance rendering !"
+ )
+
+ # render to output
+ frames=[]
+ forlayer_instanceinself.instances:
+ cur_frame=layer_instance.start
+ instance_output=Path(file_sequence.frame(cur_frame))
+ self.render_frame(
+ instance_output,cur_frame,alpha_mode,background_mode,format_opts
+ )
+ frames.append(str(cur_frame))
+
+ file_sequence.setFrameSet(FrameSet(",".join(frames)))
+ returnfile_sequence
+
@set_as_current
+defload_image(
+ self,image_path:str|Path,frame:int|None=None,stretch:bool=False
+)->None:
+"""Load an image in the current layer at a given frame.
+
+ Args:
+ image_path: path to the image to load
+ frame: the frame where the image will be loaded, if none provided, image will be loaded at current frame
+ stretch: whether to stretch the image to fit the view
+
+ Raises:
+ FileNotFoundError: if the file doesn't exist at provided path
+ """
+ image_path=Path(image_path)
+ ifnotimage_path.exists():
+ raiseFileNotFoundError(f"Image not found at : {image_path}")
+
+ frame=frameorself.clip.current_frame
+ withutils.restore_current_frame(self.clip,frame):
+ # if no instance at the specified frame, then create a new one
+ ifnotself.get_instance(frame):
+ self.add_instance(frame)
+
+ george.tv_load_image(image_path.as_posix(),stretch)
+
defget_mark_color(self,frame:int)->LayerColor|None:
+"""Get the mark color at a specific frame.
+
+ Args:
+ frame: frame with a mark
+
+ Returns:
+ LayerColor | None: the layer color if there was a mark
+ """
+ frame=frame-self.project.start_frame
+ color_index=george.tv_layer_mark_get(self.id,frame)
+ ifnotcolor_index:
+ returnNone
+
+ returnself.clip.get_layer_color(by_index=color_index)
+
defadd_mark(self,frame:int,color:LayerColor)->None:
+"""Add a mark to a frame.
+
+ Args:
+ frame: frame to put a mark on
+ color: the color index
+
+ Raises:
+ TypeError: if the layer is not an animation layer
+ """
+ ifnotself.is_anim_layer:
+ raiseTypeError(
+ f"Can't add a mark because this is not an animation layer ({self})"
+ )
+ frame=frame-self.project.start_frame
+ george.tv_layer_mark_set(self.id,frame,color.index)
+
defremove_mark(self,frame:int)->None:
+"""Remove a mark.
+
+ Args:
+ frame: a frame number with a mark
+ """
+ # Setting it at 0 clears the mark
+ self.add_mark(frame,LayerColor(0,self.clip))
+
@set_as_current
+defselect_frames(self,start:int,end:int)->None:
+"""Select the frames from a start and count.
+
+ Args:
+ start: the selection start frame
+ end: the selected end frame
+ """
+ ifnotself.is_anim_layer:
+ log.warning(
+ "Selection may display weird behaviour when applied to a non animation layer"
+ )
+ frame_count=(end-start)+1
+ george.tv_layer_select(start-self.clip.start,frame_count)
+
@set_as_current
+defselect_all_frames(self)->None:
+"""Select all frames in the layer."""
+ frame,frame_count=george.tv_layer_select_info(full=True)
+ george.tv_layer_select(frame,frame_count)
+
@set_as_current
+defclear_selection(self)->None:
+"""Clear frame selection in the layer."""
+ # selecting frames after the layer's end frame will result in a empty selection, thereby clearing the selection
+ george.tv_layer_select(self.end+1,0)
+
defget_instance(self,frame:int,strict:bool=False)->LayerInstance|None:
+"""Get the instance at that frame.
+
+ Args:
+ frame: the instance frame
+ strict: True will only return Instance if the given frame is the start of the instance. Default is False
+
+ Returns:
+ the instance if found else None
+ """
+ forlayer_instanceinself.instances:
+ ifstrict:
+ iflayer_instance.start!=frame:
+ continue
+ returnlayer_instance
+
+ ifnot(layer_instance.start<=frame<=layer_instance.end):
+ continue
+ returnlayer_instance
+
+ returnNone
+
defget_instances(self,from_frame:int,to_frame:int)->Iterator[LayerInstance]:
+"""Iterates over the layer instances and returns the one in the range (from_frame-to_frame).
+
+ Yields:
+ each LayerInstance in the range (from_frame-to_frame)
+ """
+ forlayer_instanceinself.instances:
+ iflayer_instance.end<from_frame:
+ continue
+ iffrom_frame<=layer_instance.start<=to_frame:
+ yieldlayer_instance
+ iflayer_instance.start>to_frame:
+ break
+
defadd_instance(
+ self,
+ start:int|None=None,
+ nb_frames:int=1,
+ direction:george.InsertDirection|None=None,
+ split:bool=False,
+)->LayerInstance:
+"""Crates a new instance.
+
+ Args:
+ start: start frame. Defaults to clip current frame if none provided
+ nb_frames: number of frames in the new instance. Default is 1, this is the total number of frames created.
+ direction: direction where new frames will be added/inserted
+ split: True to make each added frame a new image
+
+ Raises:
+ TypeError: if the layer is not an animation layer
+ ValueError: if the number of frames `nb_frames` is inferior or equal to 0
+ ValueError: if an instance already exists at the given range (start + nb_frames)
+
+ Returns:
+ LayerInstance: new layer instance
+ """
+ ifnotself.is_anim_layer:
+ raiseTypeError("The layer needs to be an animation layer")
+
+ ifnb_frames<=0:
+ raiseValueError("Instance number of frames must be at least 1")
+
+ ifstartandself.get_instance(start):
+ raiseValueError(
+ "An instance already exists at the designated frame range. "
+ "Edit or delete it before adding a new one."
+ )
+
+ start=startifstartisnotNoneelseself.clip.current_frame
+ self.clip.make_current()
+
+ temp_layer=Layer.new_anim_layer(str(uuid4()))
+ temp_layer.make_current()
+
+ withutils.restore_current_frame(self.clip,1):
+ ifnb_frames>1:
+ ifsplit:
+ george.tv_layer_insert_image(count=nb_frames,direction=direction)
+ else:
+ layer_instance=next(temp_layer.instances)
+ layer_instance.length=nb_frames
+
+ temp_layer.select_all_frames()
+ temp_layer.copy_selection()
+ self.clip.current_frame=start
+ self.make_current()
+ self.paste_selection()
+ temp_layer.remove()
+
+ returnLayerInstance(self,start)
+
defrename_instances(
+ self,
+ mode:george.InstanceNamingMode,
+ prefix:str|None=None,
+ suffix:str|None=None,
+ process:george.InstanceNamingProcess|None=None,
+)->None:
+"""Rename all the instances.
+
+ Args:
+ mode: the instance renaming mode
+ prefix: the prefix to add to each name
+ suffix: the suffix to add to each name
+ process: the instance naming process
+ """
+ george.tv_instance_name(self.id,mode,prefix,suffix,process)
+
def__init__(
+ self,
+ color_index:int,
+ clip:Clip|None=None,
+)->None:
+"""Construct a LayerColor from an index and a clip (if None it gets the current clip)."""
+ frompytvpaint.clipimportClip
+
+ super().__init__()
+ self._index=color_index
+ self._clip=cliporClip.current_clip()
+ self._data=george.tv_layer_color_get_color(self.clip.id,self._index)
+
@name.setter
+defname(self,value:str)->None:
+"""Set the name of the color."""
+ clip_layer_color_names=(color.nameforcolorinself.clip.layer_colors)
+ value=utils.get_unique_name(clip_layer_color_names,value)
+ george.tv_layer_color_set_color(self.clip.id,self.index,self.color,value)
+
@color.setter
+defcolor(self,value:george.RGBColor)->None:
+"""Set the color value."""
+ george.tv_layer_color_set_color(self.clip.id,self.index,value)
+
deflock_layers(self,lock:bool)->None:
+"""Lock or unlock all layers with this color."""
+ self.clip.make_current()
+ iflock:
+ george.tv_layer_color_lock(self.index)
+ else:
+ george.tv_layer_color_unlock(self.index)
+
defshow_layers(
+ self,
+ show:bool,
+ mode:george.LayerColorDisplayOpt=george.LayerColorDisplayOpt.DISPLAY,
+)->None:
+"""Show or hide layers with this color.
+
+ Args:
+ show: whether to show the layers using this color or not
+ mode: the display mode. Defaults to george.LayerColorDisplayOpt.DISPLAY.
+ """
+ self.clip.make_current()
+ ifshow:
+ george.tv_layer_color_show(mode,self.index)
+ else:
+ george.tv_layer_color_hide(mode,self.index)
+
defsplit(self,at_frame:int)->LayerInstance:
+"""Split the instance into two instances at the given frame.
+
+ Args:
+ at_frame: the frame where the split will occur
+
+ Raises:
+ ValueError: If `at_frame` is superior to the instance's end frame
+
+ Returns:
+ LayerInstance: the new layer instance
+ """
+ ifat_frame>self.end:
+ raiseValueError(
+ f"`at_frame` must be in range of the instance's start-end ({self.start}-{self.end})"
+ )
+
+ self.layer.make_current()
+ real_frame=at_frame-self.layer.project.start_frame
+ george.tv_exposure_break(real_frame)
+
+ returnLayerInstance(self.layer,at_frame)
+
defduplicate(
+ self,direction:george.InsertDirection=george.InsertDirection.AFTER
+)->None:
+"""Duplicate the instance and insert it in the given direction."""
+ self.layer.make_current()
+
+ # tvp won't insert images if the insert frame is the same as the instance start, let's move it
+ move_frame=self.layer.clip.current_frame
+ ifmove_frame==self.startandself.layer.start!=self.start:
+ move_frame=self.layer.start
+ else:
+ move_frame=self.layer.end+1
+
+ withutils.restore_current_frame(self.layer.clip,move_frame):
+ self.copy()
+ at_frame=(
+ self.endifdirection==george.InsertDirection.AFTERelseself.start
+ )
+ self.paste(at_frame=at_frame)
+
Cut all the frames/images/exposures of the instance and store them in the image buffer.
+
+
+ Source code in pytvpaint/layer.py
+
153
+154
+155
+156
+157
defcut(self)->None:
+"""Cut all the frames/images/exposures of the instance and store them in the image buffer."""
+ self.layer.make_current()
+ self.select()
+ self.layer.cut_selection()
+
Copy all the frames/images/exposures of the instance and store them in the image buffer.
+
+
+ Source code in pytvpaint/layer.py
+
159
+160
+161
+162
+163
defcopy(self)->None:
+"""Copy all the frames/images/exposures of the instance and store them in the image buffer."""
+ self.layer.make_current()
+ self.select()
+ self.layer.copy_selection()
+
defpaste(self,at_frame:int|None)->None:
+"""Paste all the frames/images/exposures stored in the image buffer to the current instance at the given frame.
+
+ Args:
+ at_frame: the frame where the stored frames will be pasted. Default is the current frame
+ """
+ at_frame=at_frameifat_frameisnotNoneelseself.layer.clip.current_frame
+
+ self.layer.make_current()
+ withutils.restore_current_frame(self.layer.clip,at_frame):
+ self.layer.paste_selection()
+
defrefresh(self)->None:
+"""Refreshed the project data.
+
+ Raises:
+ ValueError: if project has been closed
+ """
+ ifself._is_closed:
+ msg="Project already closed, load the project again to get data"
+ raiseValueError(msg)
+ ifnotself.refresh_on_callandself._data:
+ return
+
+ self._data=george.tv_project_info(self._id)
+
@set_as_current
+defresize(
+ self,
+ width:int,
+ height:int,
+ overwrite:bool=False,
+ resize_opt:george.ResizeOption|None=None,
+)->Project:
+"""Resize the current project and returns a new one.
+
+ Args:
+ width: the new width
+ height: the new height
+ overwrite: overwrite the original project, default is to create a new project
+ resize_opt: how to resize the project
+
+ Returns:
+ the newly resized project
+ """
+ if(width,height)==(self.width,self.height):
+ returnself
+
+ origin_position=self.position
+ origin_path=self.path
+
+ ifresize_opt:
+ george.tv_resize_page(width,height,resize_opt)
+ else:
+ george.tv_resize_project(width,height)
+
+ # The resized project is at the same position and replaced the original one
+ resized_id=george.tv_project_enum_id(origin_position)
+ resized_project=Project(resized_id)
+
+ ifoverwrite:
+ resized_project.save(origin_path)
+
+ returnresized_project
+
@set_as_current
+defclear_background(self)->None:
+"""Clear the background color and set it to None."""
+ self.background_mode=george.BackgroundMode.NONE
+ self.background_colors=(
+ george.RGBColor(255,255,255),
+ george.RGBColor(0,0,0),
+ )
+
@staticmethod
+defcurrent_scene_ids()->Iterator[int]:
+"""Yields the current project's scene ids."""
+ returnutils.position_generator(lambdapos:george.tv_scene_enum_id(pos))
+
defget_scene(
+ self,
+ by_id:int|None=None,
+ by_name:str|None=None,
+)->Scene|None:
+"""Find a scene in the project by id or name."""
+ forsceneinself.scenes:
+ if(by_idandscene.id==by_id)or(by_nameandscene.name==by_name):
+ returnscene
+
+ returnNone
+
@set_as_current
+defadd_scene(self)->Scene:
+"""Add a new scene in the project."""
+ frompytvpaint.sceneimportScene
+
+ returnScene.new(project=self)
+
Add a new clip in the given scene or the current one if no scene provided.
+
+
+ Source code in pytvpaint/project.py
+
415
+416
+417
+418
defadd_clip(self,clip_name:str,scene:Scene|None=None)->Clip:
+"""Add a new clip in the given scene or the current one if no scene provided."""
+ scene=sceneorself.current_scene
+ returnscene.add_clip(clip_name)
+
if the render failed and no files were found on disk or missing frames
+
+
+
+
+
+
+
+ Note
+
This functions uses the project's timeline as a basis for the range (start-end). This timeline includes all
+the project's clips and is different from a clip range. For more details on the differences in frame ranges
+and the timeline in TVPaint, please check the Usage/Rendering section of the documentation.
+
+
+ Warning
+
Even tough pytvpaint does a pretty good job of correcting the frame ranges for rendering, we're still
+encountering some weird edge cases where TVPaint will consider the range invalid for seemingly no reason.
@set_as_current
+defrender(
+ self,
+ output_path:Path|str|FileSequence,
+ start:int|None=None,
+ end:int|None=None,
+ use_camera:bool=False,
+ alpha_mode:george.AlphaSaveMode=george.AlphaSaveMode.PREMULTIPLY,
+ background_mode:george.BackgroundMode|None=None,
+ format_opts:list[str]|None=None,
+)->None:
+"""Render the project to a single frame or frame sequence or movie.
+
+ Args:
+ output_path: a single file or file sequence pattern
+ start: the start frame to render or the mark in or the project's start frame if None. Defaults to None.
+ end: the end frame to render or the mark out or the project's end frame if None. Defaults to None.
+ use_camera: use the camera for rendering, otherwise render the whole canvas. Defaults to False.
+ alpha_mode: the alpha mode for rendering. Defaults to george.AlphaSaveMode.PREMULTIPLY.
+ background_mode: the background mode for rendering. Defaults to george.BackgroundMode.NONE.
+ format_opts: custom format options. Defaults to None.
+
+ Raises:
+ ValueError: if requested range (start-end) not in project range/bounds
+ ValueError: if output is a movie, and it's duration is equal to 1 frame
+ FileNotFoundError: if the render failed and no files were found on disk or missing frames
+
+ Note:
+ This functions uses the project's timeline as a basis for the range (start-end). This timeline includes all
+ the project's clips and is different from a clip range. For more details on the differences in frame ranges
+ and the timeline in TVPaint, please check the `Usage/Rendering` section of the documentation.
+
+ Warning:
+ Even tough pytvpaint does a pretty good job of correcting the frame ranges for rendering, we're still
+ encountering some weird edge cases where TVPaint will consider the range invalid for seemingly no reason.
+ """
+ default_start=self.mark_inorself.start_frame
+ default_end=self.mark_outorself.end_frame
+
+ self._render(
+ output_path,
+ default_start,
+ default_end,
+ start,
+ end,
+ use_camera,
+ layer_selection=None,
+ alpha_mode=alpha_mode,
+ background_mode=background_mode,
+ format_opts=format_opts,
+ )
+
@staticmethod
+defopen_projects_ids()->Iterator[str]:
+"""Yields the ids of the currently open projects."""
+ returnutils.position_generator(lambdapos:george.tv_project_enum_id(pos))
+
@classmethod
+defopen_projects(cls)->Iterator[Project]:
+"""Iterator over the currently open projects."""
+ forproject_idinProject.open_projects_ids():
+ yieldProject(project_id)
+
@set_as_current
+defduplicate(self)->Project:
+"""Duplicate the project and return the new one."""
+ george.tv_project_duplicate()
+ duplicated=Project.current_project()
+ self.make_current()
+ returnduplicated
+
@classmethod
+defclose_all(cls,close_tvp:bool=False)->None:
+"""Closes all open projects.
+
+ Args:
+ close_tvp: close the TVPaint instance as well
+ """
+ forprojectinlist(cls.open_projects()):
+ project.close()
+
+ ifclose_tvp:
+ george.tv_quit()
+
@set_as_current
+defsave_palette(self,save_path:Path|str|None=None)->None:
+"""Save a palette to the given path."""
+ save_path=Path(save_pathorself.path)
+ george.tv_save_project(save_path)
+
@set_as_current
+defremove(self)->None:
+"""Remove the sound from the project."""
+ george.tv_sound_project_remove(self.track_index)
+ self.mark_removed()
+
@staticmethod
+defcurrent_scene()->Scene:
+"""Returns the current scene of the current project."""
+ returnScene(
+ scene_id=george.tv_scene_current_id(),
+ project=Project.current_project(),
+ )
+
@classmethod
+defnew(cls,project:Project|None=None)->Scene:
+"""Creates a new scene in the provided project."""
+ project=projectorProject.current_project()
+ project.make_current()
+ george.tv_scene_new()
+ returncls.current_scene()
+
defmake_current(self)->None:
+"""Make this scene the current one."""
+ ifself.is_current:
+ return
+
+ # In order to select the scene, we select any child clip inside of it
+ first_clip_id=george.tv_clip_enum_id(self.id,0)
+ george.tv_clip_select(first_clip_id)
+
@set_as_current
+defadd_clip(self,clip_name:str)->Clip:
+"""Adds a new clip to the scene."""
+ self.make_current()
+ returnClip.new(name=clip_name,project=self.project)
+
All Clip instances will be invalid after removing the scene.
+There's no protection mechanism to prevent accessing clip data that doesn't exist anymore.
+
+
+ Source code in pytvpaint/scene.py
+
136
+137
+138
+139
+140
+141
+142
+143
+144
defremove(self)->None:
+"""Remove the scene and all the clips inside.
+
+ Warning:
+ All `Clip` instances will be invalid after removing the scene.
+ There's no protection mechanism to prevent accessing clip data that doesn't exist anymore.
+ """
+ george.tv_scene_close(self._id)
+ self.mark_removed()
+
defrefresh(self)->None:
+"""Does a refresh of the object data.
+
+ Raises:
+ ValueError: if the object has been mark removed
+ """
+ ifself._is_removed:
+ raiseValueError(f"{self.__class__.__name__} has been removed!")
+
@abstractmethod
+defremove(self)->None:
+"""Removes the object in TVPaint."""
+ raiseNotImplementedError("Function refresh() needs to be implemented")
+
defget_unique_name(names:Iterable[str],stub:str)->str:
+"""Get a unique name from a list of names and a stub prefix. It does auto increment it.
+
+ Args:
+ names (Iterable[str]): existing names
+ stub (str): the base name
+
+ Raises:
+ ValueError: if the stub is empty
+
+ Returns:
+ str: a unique name with the stub prefix
+ """
+ ifnotstub:
+ raiseValueError("Stub is empty")
+
+ number_re=re.compile(r"(?P<number>\d+)$",re.I)
+
+ stub_without_number=number_re.sub("",stub)
+ max_number=0
+ padding_length=1
+
+ fornameinnames:
+ without_number=number_re.sub("",name)
+
+ ifwithout_number!=stub_without_number:
+ continue
+
+ res=number_re.search(name)
+ number=res.group("number")ifreselse"1"
+
+ padding_length=max(padding_length,len(number))
+ max_number=max(max_number,int(number))
+
+ ifmax_number==0:
+ returnstub
+
+ next_number=max_number+1
+ returnf"{stub_without_number}{next_number:0{padding_length}}"
+
defposition_generator(
+ fn:Callable[[int],T],
+ stop_when:type[GeorgeError]=GeorgeError,
+)->Iterator[T]:
+"""Utility generator that yields the result of a function according to a position.
+
+ Args:
+ fn (Callable[[int], T]): the function to run at each iteration
+ stop_when (Type[GeorgeError], optional): exception at which we stop. Defaults to GeorgeError.
+
+ Yields:
+ Iterator[T]: an generator of the resulting values
+ """
+ pos=0
+
+ whileTrue:
+ try:
+ yieldfn(pos)
+ exceptstop_when:
+ break
+ pos+=1
+
defset_as_current(func:Callable[Params,ReturnType])->Callable[Params,ReturnType]:
+"""Decorator to apply on object methods.
+
+ Sets the current TVPaint object as 'current'.
+ Useful when George functions only apply on the current project, clip, layer or scene.
+
+ Args:
+ func (Callable[Params, ReturnType]): the method apply on
+
+ Returns:
+ Callable[Params, ReturnType]: the wrapped method
+ """
+
+ defwrapper(*args:Params.args,**kwargs:Params.kwargs)->ReturnType:
+ self=cast(CanMakeCurrent,args[0])
+ self.make_current()
+ returnfunc(*args,**kwargs)
+
+ returnwrapper
+
@contextlib.contextmanager
+defrender_context(
+ alpha_mode:george.AlphaSaveMode|None=None,
+ background_mode:george.BackgroundMode|None=None,
+ save_format:george.SaveFormat|None=None,
+ format_opts:list[str]|None=None,
+ layer_selection:list[Layer]|None=None,
+)->Generator[None,None,None]:
+"""Context used to do renders in TVPaint.
+
+ It does the following things:
+
+ - Set the alpha mode and save format (with custom options)
+ - Hide / Show the given layers (some render functions only render by visibility)
+ - Restore the previous values after rendering
+
+ Args:
+ alpha_mode: the render alpha save mode
+ save_format: the render format to use. Defaults to None.
+ background_mode: the render background mode
+ format_opts: the custom format options as strings. Defaults to None.
+ layer_selection: the layers to render. Defaults to None.
+ """
+ frompytvpaint.clipimportClip
+
+ # Save the current state
+ pre_alpha_save_mode=george.tv_alpha_save_mode_get()
+ pre_save_format,pre_save_args=george.tv_save_mode_get()
+ pre_background_mode,pre_background_colors=george.tv_background_get()
+
+ # Set the save mode values
+ ifalpha_mode:
+ george.tv_alpha_save_mode_set(alpha_mode)
+ ifbackground_mode:
+ george.tv_background_set(background_mode)
+ ifsave_format:
+ george.tv_save_mode_set(save_format,*(format_optsor[]))
+
+ layers_visibility=[]
+ iflayer_selection:
+ clip=Clip.current_clip()
+ layers_visibility=[(layer,layer.is_visible)forlayerinclip.layers]
+ # Show and hide the clip layers to render
+ forlayer,_inlayers_visibility:
+ should_be_visible=notlayer_selectionorlayerinlayer_selection
+ layer.is_visible=should_be_visible
+
+ # Do the render
+ yield
+
+ # Restore the previous values
+ ifalpha_mode:
+ george.tv_alpha_save_mode_set(pre_alpha_save_mode)
+ ifsave_format:
+ george.tv_save_mode_set(pre_save_format,*pre_save_args)
+ ifbackground_mode:
+ george.tv_background_set(pre_background_mode,pre_background_colors)
+
+ # Restore the layer visibility
+ iflayers_visibility:
+ forlayer,was_visibleinlayers_visibility:
+ layer.is_visible=was_visible
+
@contextlib.contextmanager
+defrestore_current_frame(
+ tvp_element:HasCurrentFrame,frame:int
+)->Generator[None,None,None]:
+"""Context that temporarily changes the current frame to the one provided and restores it when done.
+
+ Args:
+ tvp_element: clip to change
+ frame: frame to set. Defaults to None.
+ """
+ previous_frame=tvp_element.current_frame
+
+ ifframe!=previous_frame:
+ tvp_element.current_frame=frame
+
+ yield
+
+ iftvp_element.current_frame!=previous_frame:
+ tvp_element.current_frame=previous_frame
+
defget_tvp_element(
+ tvp_elements:Iterator[TVPElementType],
+ by_id:int|str|None=None,
+ by_name:str|None=None,
+ by_path:str|Path|None=None,
+)->TVPElementType|None:
+"""Search for a TVPaint element by attributes.
+
+ Args:
+ tvp_elements: a collection of TVPaint objects
+ by_id: search by id. Defaults to None.
+ by_name: search by name, search is case-insensitive. Defaults to None.
+ by_path: search by path. Defaults to None.
+
+ Raises:
+ ValueError: if bad arguments were given
+
+ Returns:
+ TVPElementType | None: the found element
+ """
+ ifby_idisNoneandby_nameisNone:
+ raiseValueError(
+ "At least one of the values (id or name) must be provided, none found !"
+ )
+
+ forelementintvp_elements:
+ ifby_idisnotNoneandelement.id!=by_id:
+ continue
+ ifby_nameisnotNoneandelement.name.lower()!=by_name.lower():
+ continue
+ ifby_pathisnotNoneandgetattr(element,"path")!=Path(by_path):
+ continue
+ returnelement
+
+ returnNone
+
Handle the different options for output paths and range.
+
Whether the user provides a range (start-end) or a filesequence with a range or not, this functions ensures we
+always end up with a valid range to render
defhandle_output_range(
+ output_path:Path|str|FileSequence,
+ default_start:int,
+ default_end:int,
+ start:int|None=None,
+ end:int|None=None,
+)->tuple[FileSequence,int,int,bool,bool]:
+"""Handle the different options for output paths and range.
+
+ Whether the user provides a range (start-end) or a filesequence with a range or not, this functions ensures we
+ always end up with a valid range to render
+
+ Args:
+ output_path: user provided output path
+ default_start: the default start to use if none provided or found in the file sequence object
+ default_end: the default end to use if none provided or found in the file sequence object
+ start: user provided start frame or None
+ end: user provided end frame or None
+
+ Returns:
+ file_sequence: output path as a FileSequence object
+ start: computed start frame
+ end: computed end frame
+ is_sequence: whether the output is a sequence or not
+ is_image: whether the output is an image or not (a movie)
+ """
+ # we handle all outputs as a FileSequence, makes it a bit easier to handle ranges and padding
+ ifnotisinstance(output_path,FileSequence):
+ file_sequence=FileSequence(Path(output_path).as_posix())
+ else:
+ file_sequence=output_path
+
+ frame_set=file_sequence.frameSet()
+ is_image=george.SaveFormat.is_image(file_sequence.extension())
+
+ # if the provided sequence has a range, and we don't, use the sequence range
+ ifframe_setandlen(frame_set)>=1andis_image:
+ start=startorfile_sequence.start()
+ end=endorfile_sequence.end()
+
+ # check characteristics of file sequence
+ fseq_has_range=frame_setandlen(frame_set)>1
+ fseq_is_single_image=frame_setandlen(frame_set)==1
+ fseq_no_range_padding=notframe_setandfile_sequence.padding()
+ range_is_seq=startisnotNoneandendisnotNoneandstart!=end
+ range_is_single_image=startisnotNoneandendisnotNoneandstart==end
+
+ is_single_image=bool(
+ is_imageand(fseq_is_single_imageornotframe_set)andrange_is_single_image
+ )
+ is_sequence=bool(
+ is_imageand(fseq_has_rangeorfseq_no_range_paddingorrange_is_seq)
+ )
+
+ # if no range provided, use clip mark in/out, if none, use clip start/end
+ ifstartisNone:
+ start=default_start
+ ifis_single_imageandnotend:
+ end=start
+ else:
+ ifendisNone:
+ end=default_end
+
+ frame_set=FrameSet(f"{start}-{end}")
+
+ ifnotfile_sequence.padding()andis_imageandlen(frame_set)>1:
+ file_sequence.setPadding("#")
+
+ # we should have a range by now, set it in the sequence
+ if(is_imageandnotis_single_image)orfile_sequence.padding():
+ file_sequence.setFrameSet(frame_set)
+
+ returnfile_sequence,start,end,is_sequence,is_image
+
{"use strict";/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */var Va=/["'&<>]/;qn.exports=za;function za(e){var t=""+e,r=Va.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i0&&i[i.length-1])&&(p[0]===6||p[0]===2)){r=0;continue}if(p[0]===3&&(!i||p[1]>i[0]&&p[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function V(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],s;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(a){s={error:a}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(s)throw s.error}}return i}function z(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||a(u,h)})})}function a(u,h){try{c(o[u](h))}catch(w){f(i[0][3],w)}}function c(u){u.value instanceof ot?Promise.resolve(u.value.v).then(p,l):f(i[0][2],u)}function p(u){a("next",u)}function l(u){a("throw",u)}function f(u,h){u(h),i.shift(),i.length&&a(i[0][0],i[0][1])}}function so(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof ue=="function"?ue(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(s){return new Promise(function(a,c){s=e[i](s),n(a,c,s.done,s.value)})}}function n(i,s,a,c){Promise.resolve(c).then(function(p){i({value:p,done:a})},s)}}function k(e){return typeof e=="function"}function pt(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var Wt=pt(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription:
+`+r.map(function(o,n){return n+1+") "+o.toString()}).join(`
+ `):"",this.name="UnsubscriptionError",this.errors=r}});function Ve(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Ie=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var s=this._parentage;if(s)if(this._parentage=null,Array.isArray(s))try{for(var a=ue(s),c=a.next();!c.done;c=a.next()){var p=c.value;p.remove(this)}}catch(A){t={error:A}}finally{try{c&&!c.done&&(r=a.return)&&r.call(a)}finally{if(t)throw t.error}}else s.remove(this);var l=this.initialTeardown;if(k(l))try{l()}catch(A){i=A instanceof Wt?A.errors:[A]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=ue(f),h=u.next();!h.done;h=u.next()){var w=h.value;try{co(w)}catch(A){i=i!=null?i:[],A instanceof Wt?i=z(z([],V(i)),V(A.errors)):i.push(A)}}}catch(A){o={error:A}}finally{try{h&&!h.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new Wt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)co(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Ve(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Ve(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Er=Ie.EMPTY;function Dt(e){return e instanceof Ie||e&&"closed"in e&&k(e.remove)&&k(e.add)&&k(e.unsubscribe)}function co(e){k(e)?e():e.unsubscribe()}var ke={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var lt={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,s=n.isStopped,a=n.observers;return i||s?Er:(this.currentObservers=null,a.push(r),new Ie(function(){o.currentObservers=null,Ve(a,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,s=o.isStopped;n?r.error(i):s&&r.complete()},t.prototype.asObservable=function(){var r=new j;return r.source=this,r},t.create=function(r,o){return new vo(r,o)},t}(j);var vo=function(e){se(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Er},t}(v);var St={now:function(){return(St.delegate||Date).now()},delegate:void 0};var Ot=function(e){se(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=St);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,s=o._infiniteTimeWindow,a=o._timestampProvider,c=o._windowTime;n||(i.push(r),!s&&i.push(a.now()+c)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,s=n._buffer,a=s.slice(),c=0;c0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=ut.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var s=r.actions;o!=null&&((i=s[s.length-1])===null||i===void 0?void 0:i.id)!==o&&(ut.cancelAnimationFrame(o),r._scheduled=void 0)},t}(zt);var yo=function(e){se(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(qt);var de=new yo(xo);var L=new j(function(e){return e.complete()});function Kt(e){return e&&k(e.schedule)}function _r(e){return e[e.length-1]}function Je(e){return k(_r(e))?e.pop():void 0}function Ae(e){return Kt(_r(e))?e.pop():void 0}function Qt(e,t){return typeof _r(e)=="number"?e.pop():t}var dt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Yt(e){return k(e==null?void 0:e.then)}function Bt(e){return k(e[ft])}function Gt(e){return Symbol.asyncIterator&&k(e==null?void 0:e[Symbol.asyncIterator])}function Jt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Di(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Xt=Di();function Zt(e){return k(e==null?void 0:e[Xt])}function er(e){return ao(this,arguments,function(){var r,o,n,i;return Ut(this,function(s){switch(s.label){case 0:r=e.getReader(),s.label=1;case 1:s.trys.push([1,,9,10]),s.label=2;case 2:return[4,ot(r.read())];case 3:return o=s.sent(),n=o.value,i=o.done,i?[4,ot(void 0)]:[3,5];case 4:return[2,s.sent()];case 5:return[4,ot(n)];case 6:return[4,s.sent()];case 7:return s.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function tr(e){return k(e==null?void 0:e.getReader)}function N(e){if(e instanceof j)return e;if(e!=null){if(Bt(e))return Ni(e);if(dt(e))return Vi(e);if(Yt(e))return zi(e);if(Gt(e))return Eo(e);if(Zt(e))return qi(e);if(tr(e))return Ki(e)}throw Jt(e)}function Ni(e){return new j(function(t){var r=e[ft]();if(k(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Vi(e){return new j(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?g(function(n,i){return e(n,i,o)}):ce,ye(1),r?Qe(t):jo(function(){return new or}))}}function $r(e){return e<=0?function(){return L}:x(function(t,r){var o=[];t.subscribe(S(r,function(n){o.push(n),e=2,!0))}function le(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new v}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,s=i===void 0?!0:i,a=e.resetOnRefCountZero,c=a===void 0?!0:a;return function(p){var l,f,u,h=0,w=!1,A=!1,Z=function(){f==null||f.unsubscribe(),f=void 0},te=function(){Z(),l=u=void 0,w=A=!1},J=function(){var C=l;te(),C==null||C.unsubscribe()};return x(function(C,ct){h++,!A&&!w&&Z();var Ne=u=u!=null?u:r();ct.add(function(){h--,h===0&&!A&&!w&&(f=Pr(J,c))}),Ne.subscribe(ct),!l&&h>0&&(l=new it({next:function(Pe){return Ne.next(Pe)},error:function(Pe){A=!0,Z(),f=Pr(te,n,Pe),Ne.error(Pe)},complete:function(){w=!0,Z(),f=Pr(te,s),Ne.complete()}}),N(C).subscribe(l))})(p)}}function Pr(e,t){for(var r=[],o=2;oe.next(document)),e}function R(e,t=document){return Array.from(t.querySelectorAll(e))}function P(e,t=document){let r=me(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function me(e,t=document){return t.querySelector(e)||void 0}function Re(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var la=T(d(document.body,"focusin"),d(document.body,"focusout")).pipe(be(1),q(void 0),m(()=>Re()||document.body),B(1));function vt(e){return la.pipe(m(t=>e.contains(t)),Y())}function Vo(e,t){return T(d(e,"mouseenter").pipe(m(()=>!0)),d(e,"mouseleave").pipe(m(()=>!1))).pipe(t?be(t):ce,q(!1))}function Ue(e){return{x:e.offsetLeft,y:e.offsetTop}}function zo(e){return T(d(window,"load"),d(window,"resize")).pipe(Me(0,de),m(()=>Ue(e)),q(Ue(e)))}function ir(e){return{x:e.scrollLeft,y:e.scrollTop}}function et(e){return T(d(e,"scroll"),d(window,"resize")).pipe(Me(0,de),m(()=>ir(e)),q(ir(e)))}function qo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)qo(e,r)}function E(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)qo(o,n);return o}function ar(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function gt(e){let t=E("script",{src:e});return H(()=>(document.head.appendChild(t),T(d(t,"load"),d(t,"error").pipe(b(()=>Ar(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),_(()=>document.head.removeChild(t)),ye(1))))}var Ko=new v,ma=H(()=>typeof ResizeObserver=="undefined"?gt("https://unpkg.com/resize-observer-polyfill"):$(void 0)).pipe(m(()=>new ResizeObserver(e=>{for(let t of e)Ko.next(t)})),b(e=>T(qe,$(e)).pipe(_(()=>e.disconnect()))),B(1));function pe(e){return{width:e.offsetWidth,height:e.offsetHeight}}function Ee(e){return ma.pipe(y(t=>t.observe(e)),b(t=>Ko.pipe(g(({target:r})=>r===e),_(()=>t.unobserve(e)),m(()=>pe(e)))),q(pe(e)))}function xt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function sr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}var Qo=new v,fa=H(()=>$(new IntersectionObserver(e=>{for(let t of e)Qo.next(t)},{threshold:0}))).pipe(b(e=>T(qe,$(e)).pipe(_(()=>e.disconnect()))),B(1));function yt(e){return fa.pipe(y(t=>t.observe(e)),b(t=>Qo.pipe(g(({target:r})=>r===e),_(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function Yo(e,t=16){return et(e).pipe(m(({y:r})=>{let o=pe(e),n=xt(e);return r>=n.height-o.height-t}),Y())}var cr={drawer:P("[data-md-toggle=drawer]"),search:P("[data-md-toggle=search]")};function Bo(e){return cr[e].checked}function Be(e,t){cr[e].checked!==t&&cr[e].click()}function We(e){let t=cr[e];return d(t,"change").pipe(m(()=>t.checked),q(t.checked))}function ua(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function da(){return T(d(window,"compositionstart").pipe(m(()=>!0)),d(window,"compositionend").pipe(m(()=>!1))).pipe(q(!1))}function Go(){let e=d(window,"keydown").pipe(g(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:Bo("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),g(({mode:t,type:r})=>{if(t==="global"){let o=Re();if(typeof o!="undefined")return!ua(o,r)}return!0}),le());return da().pipe(b(t=>t?L:e))}function ve(){return new URL(location.href)}function st(e,t=!1){if(G("navigation.instant")&&!t){let r=E("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function Jo(){return new v}function Xo(){return location.hash.slice(1)}function Zo(e){let t=E("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function ha(e){return T(d(window,"hashchange"),e).pipe(m(Xo),q(Xo()),g(t=>t.length>0),B(1))}function en(e){return ha(e).pipe(m(t=>me(`[id="${t}"]`)),g(t=>typeof t!="undefined"))}function At(e){let t=matchMedia(e);return nr(r=>t.addListener(()=>r(t.matches))).pipe(q(t.matches))}function tn(){let e=matchMedia("print");return T(d(window,"beforeprint").pipe(m(()=>!0)),d(window,"afterprint").pipe(m(()=>!1))).pipe(q(e.matches))}function Ur(e,t){return e.pipe(b(r=>r?t():L))}function Wr(e,t){return new j(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let s=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+s*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function De(e,t){return Wr(e,t).pipe(b(r=>r.text()),m(r=>JSON.parse(r)),B(1))}function rn(e,t){let r=new DOMParser;return Wr(e,t).pipe(b(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),B(1))}function on(e,t){let r=new DOMParser;return Wr(e,t).pipe(b(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),B(1))}function nn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function an(){return T(d(window,"scroll",{passive:!0}),d(window,"resize",{passive:!0})).pipe(m(nn),q(nn()))}function sn(){return{width:innerWidth,height:innerHeight}}function cn(){return d(window,"resize",{passive:!0}).pipe(m(sn),q(sn()))}function pn(){return Q([an(),cn()]).pipe(m(([e,t])=>({offset:e,size:t})),B(1))}function pr(e,{viewport$:t,header$:r}){let o=t.pipe(X("size")),n=Q([o,r]).pipe(m(()=>Ue(e)));return Q([r,t,n]).pipe(m(([{height:i},{offset:s,size:a},{x:c,y:p}])=>({offset:{x:s.x-c,y:s.y-p+i},size:a})))}function ba(e){return d(e,"message",t=>t.data)}function va(e){let t=new v;return t.subscribe(r=>e.postMessage(r)),t}function ln(e,t=new Worker(e)){let r=ba(t),o=va(t),n=new v;n.subscribe(o);let i=o.pipe(ee(),oe(!0));return n.pipe(ee(),$e(r.pipe(U(i))),le())}var ga=P("#__config"),Et=JSON.parse(ga.textContent);Et.base=`${new URL(Et.base,ve())}`;function we(){return Et}function G(e){return Et.features.includes(e)}function ge(e,t){return typeof t!="undefined"?Et.translations[e].replace("#",t.toString()):Et.translations[e]}function Te(e,t=document){return P(`[data-md-component=${e}]`,t)}function ne(e,t=document){return R(`[data-md-component=${e}]`,t)}function xa(e){let t=P(".md-typeset > :first-child",e);return d(t,"click",{once:!0}).pipe(m(()=>P(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function mn(e){if(!G("announce.dismiss")||!e.childElementCount)return L;if(!e.hidden){let t=P(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return H(()=>{let t=new v;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),xa(e).pipe(y(r=>t.next(r)),_(()=>t.complete()),m(r=>F({ref:e},r)))})}function ya(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function fn(e,t){let r=new v;return r.subscribe(({hidden:o})=>{e.hidden=o}),ya(e,t).pipe(y(o=>r.next(o)),_(()=>r.complete()),m(o=>F({ref:e},o)))}function Ct(e,t){return t==="inline"?E("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},E("div",{class:"md-tooltip__inner md-typeset"})):E("div",{class:"md-tooltip",id:e,role:"tooltip"},E("div",{class:"md-tooltip__inner md-typeset"}))}function un(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return E("aside",{class:"md-annotation",tabIndex:0},Ct(t),E("a",{href:r,class:"md-annotation__index",tabIndex:-1},E("span",{"data-md-annotation-id":e})))}else return E("aside",{class:"md-annotation",tabIndex:0},Ct(t),E("span",{class:"md-annotation__index",tabIndex:-1},E("span",{"data-md-annotation-id":e})))}function dn(e){return E("button",{class:"md-clipboard md-icon",title:ge("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}function Dr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(c=>!e.terms[c]).reduce((c,p)=>[...c,E("del",null,p)," "],[]).slice(0,-1),i=we(),s=new URL(e.location,i.base);G("search.highlight")&&s.searchParams.set("h",Object.entries(e.terms).filter(([,c])=>c).reduce((c,[p])=>`${c} ${p}`.trim(),""));let{tags:a}=we();return E("a",{href:`${s}`,class:"md-search-result__link",tabIndex:-1},E("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&E("div",{class:"md-search-result__icon md-icon"}),r>0&&E("h1",null,e.title),r<=0&&E("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&e.tags.map(c=>{let p=a?c in a?`md-tag-icon md-tag--${a[c]}`:"md-tag-icon":"";return E("span",{class:`md-tag ${p}`},c)}),o>0&&n.length>0&&E("p",{class:"md-search-result__terms"},ge("search.result.term.missing"),": ",...n)))}function hn(e){let t=e[0].score,r=[...e],o=we(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),s=r.findIndex(l=>l.scoreDr(l,1)),...c.length?[E("details",{class:"md-search-result__more"},E("summary",{tabIndex:-1},E("div",null,c.length>0&&c.length===1?ge("search.result.more.one"):ge("search.result.more.other",c.length))),...c.map(l=>Dr(l,1)))]:[]];return E("li",{class:"md-search-result__item"},p)}function bn(e){return E("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>E("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?ar(r):r)))}function Nr(e){let t=`tabbed-control tabbed-control--${e}`;return E("div",{class:t,hidden:!0},E("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function vn(e){return E("div",{class:"md-typeset__scrollwrap"},E("div",{class:"md-typeset__table"},e))}function Ea(e){let t=we(),r=new URL(`../${e.version}/`,t.base);return E("li",{class:"md-version__item"},E("a",{href:`${r}`,class:"md-version__link"},e.title))}function gn(e,t){return e=e.filter(r=>{var o;return!((o=r.properties)!=null&&o.hidden)}),E("div",{class:"md-version"},E("button",{class:"md-version__current","aria-label":ge("select.version")},t.title),E("ul",{class:"md-version__list"},e.map(Ea)))}var wa=0;function Ta(e,t){document.body.append(e);let{width:r}=pe(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=sr(t),n=typeof o!="undefined"?et(o):$({x:0,y:0}),i=T(vt(t),Vo(t)).pipe(Y());return Q([i,n]).pipe(m(([s,a])=>{let{x:c,y:p}=Ue(t),l=pe(t),f=t.closest("table");return f&&t.parentElement&&(c+=f.offsetLeft+t.parentElement.offsetLeft,p+=f.offsetTop+t.parentElement.offsetTop),{active:s,offset:{x:c-a.x+l.width/2-r/2,y:p-a.y+l.height+8}}}))}function Ge(e){let t=e.title;if(!t.length)return L;let r=`__tooltip_${wa++}`,o=Ct(r,"inline"),n=P(".md-typeset",o);return n.innerHTML=t,H(()=>{let i=new v;return i.subscribe({next({offset:s}){o.style.setProperty("--md-tooltip-x",`${s.x}px`),o.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),T(i.pipe(g(({active:s})=>s)),i.pipe(be(250),g(({active:s})=>!s))).subscribe({next({active:s}){s?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Me(16,de)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(_t(125,de),g(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?o.style.setProperty("--md-tooltip-0",`${-s}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Ta(o,e).pipe(y(s=>i.next(s)),_(()=>i.complete()),m(s=>F({ref:e},s)))}).pipe(ze(ie))}function Sa(e,t){let r=H(()=>Q([zo(e),et(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:s,height:a}=pe(e);return{x:o-i.x+s/2,y:n-i.y+a/2}}));return vt(e).pipe(b(o=>r.pipe(m(n=>({active:o,offset:n})),ye(+!o||1/0))))}function xn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return H(()=>{let i=new v,s=i.pipe(ee(),oe(!0));return i.subscribe({next({offset:a}){e.style.setProperty("--md-tooltip-x",`${a.x}px`),e.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),yt(e).pipe(U(s)).subscribe(a=>{e.toggleAttribute("data-md-visible",a)}),T(i.pipe(g(({active:a})=>a)),i.pipe(be(250),g(({active:a})=>!a))).subscribe({next({active:a}){a?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Me(16,de)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(_t(125,de),g(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?e.style.setProperty("--md-tooltip-0",`${-a}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),d(n,"click").pipe(U(s),g(a=>!(a.metaKey||a.ctrlKey))).subscribe(a=>{a.stopPropagation(),a.preventDefault()}),d(n,"mousedown").pipe(U(s),ae(i)).subscribe(([a,{active:c}])=>{var p;if(a.button!==0||a.metaKey||a.ctrlKey)a.preventDefault();else if(c){a.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(p=Re())==null||p.blur()}}),r.pipe(U(s),g(a=>a===o),Ye(125)).subscribe(()=>e.focus()),Sa(e,t).pipe(y(a=>i.next(a)),_(()=>i.complete()),m(a=>F({ref:e},a)))})}function Oa(e){return e.tagName==="CODE"?R(".c, .c1, .cm",e):[e]}function Ma(e){let t=[];for(let r of Oa(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let s;for(;s=/(\(\d+\))(!)?/.exec(i.textContent);){let[,a,c]=s;if(typeof c=="undefined"){let p=i.splitText(s.index);i=p.splitText(a.length),t.push(p)}else{i.textContent=a,t.push(i);break}}}}return t}function yn(e,t){t.append(...Array.from(e.childNodes))}function lr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,s=new Map;for(let a of Ma(t)){let[,c]=a.textContent.match(/\((\d+)\)/);me(`:scope > li:nth-child(${c})`,e)&&(s.set(c,un(c,i)),a.replaceWith(s.get(c)))}return s.size===0?L:H(()=>{let a=new v,c=a.pipe(ee(),oe(!0)),p=[];for(let[l,f]of s)p.push([P(".md-typeset",f),P(`:scope > li:nth-child(${l})`,e)]);return o.pipe(U(c)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of p)l?yn(f,u):yn(u,f)}),T(...[...s].map(([,l])=>xn(l,t,{target$:r}))).pipe(_(()=>a.complete()),le())})}function En(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return En(t)}}function wn(e,t){return H(()=>{let r=En(e);return typeof r!="undefined"?lr(r,e,t):L})}var Tn=jt(zr());var La=0;function Sn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return Sn(t)}}function _a(e){return Ee(e).pipe(m(({width:t})=>({scrollable:xt(e).width>t})),X("scrollable"))}function On(e,t){let{matches:r}=matchMedia("(hover)"),o=H(()=>{let n=new v,i=n.pipe($r(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let s=[];if(Tn.default.isSupported()&&(e.closest(".copy")||G("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${La++}`;let p=dn(c.id);c.insertBefore(p,e),G("content.tooltips")&&s.push(Ge(p))}let a=e.closest(".highlight");if(a instanceof HTMLElement){let c=Sn(a);if(typeof c!="undefined"&&(a.classList.contains("annotate")||G("content.code.annotate"))){let p=lr(c,e,t);s.push(Ee(a).pipe(U(i),m(({width:l,height:f})=>l&&f),Y(),b(l=>l?p:L)))}}return _a(e).pipe(y(c=>n.next(c)),_(()=>n.complete()),m(c=>F({ref:e},c)),$e(...s))});return G("content.lazy")?yt(e).pipe(g(n=>n),ye(1),b(()=>o)):o}function Aa(e,{target$:t,print$:r}){let o=!0;return T(t.pipe(m(n=>n.closest("details:not([open])")),g(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(g(n=>n||!o),y(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Mn(e,t){return H(()=>{let r=new v;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),Aa(e,t).pipe(y(o=>r.next(o)),_(()=>r.complete()),m(o=>F({ref:e},o)))})}var Ln=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel rect,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel rect{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var qr,ka=0;function Ha(){return typeof mermaid=="undefined"||mermaid instanceof Element?gt("https://unpkg.com/mermaid@10.7.0/dist/mermaid.min.js"):$(void 0)}function _n(e){return e.classList.remove("mermaid"),qr||(qr=Ha().pipe(y(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Ln,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),B(1))),qr.subscribe(()=>ro(this,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${ka++}`,r=E("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),s=r.attachShadow({mode:"closed"});s.innerHTML=n,e.replaceWith(r),i==null||i(s)})),qr.pipe(m(()=>({ref:e})))}var An=E("table");function Cn(e){return e.replaceWith(An),An.replaceWith(vn(e)),$({ref:e})}function $a(e){let t=e.find(r=>r.checked)||e[0];return T(...e.map(r=>d(r,"change").pipe(m(()=>P(`label[for="${r.id}"]`))))).pipe(q(P(`label[for="${t.id}"]`)),m(r=>({active:r})))}function kn(e,{viewport$:t,target$:r}){let o=P(".tabbed-labels",e),n=R(":scope > input",e),i=Nr("prev");e.append(i);let s=Nr("next");return e.append(s),H(()=>{let a=new v,c=a.pipe(ee(),oe(!0));Q([a,Ee(e)]).pipe(U(c),Me(1,de)).subscribe({next([{active:p},l]){let f=Ue(p),{width:u}=pe(p);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let h=ir(o);(f.xh.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),Q([et(o),Ee(o)]).pipe(U(c)).subscribe(([p,l])=>{let f=xt(o);i.hidden=p.x<16,s.hidden=p.x>f.width-l.width-16}),T(d(i,"click").pipe(m(()=>-1)),d(s,"click").pipe(m(()=>1))).pipe(U(c)).subscribe(p=>{let{width:l}=pe(o);o.scrollBy({left:l*p,behavior:"smooth"})}),r.pipe(U(c),g(p=>n.includes(p))).subscribe(p=>p.click()),o.classList.add("tabbed-labels--linked");for(let p of n){let l=P(`label[for="${p.id}"]`);l.replaceChildren(E("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),d(l.firstElementChild,"click").pipe(U(c),g(f=>!(f.metaKey||f.ctrlKey)),y(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return G("content.tabs.link")&&a.pipe(Le(1),ae(t)).subscribe(([{active:p},{offset:l}])=>{let f=p.innerText.trim();if(p.hasAttribute("data-md-switching"))p.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let w of R("[data-tabs]"))for(let A of R(":scope > input",w)){let Z=P(`label[for="${A.id}"]`);if(Z!==p&&Z.innerText.trim()===f){Z.setAttribute("data-md-switching",""),A.click();break}}window.scrollTo({top:e.offsetTop-u});let h=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...h])])}}),a.pipe(U(c)).subscribe(()=>{for(let p of R("audio, video",e))p.pause()}),$a(n).pipe(y(p=>a.next(p)),_(()=>a.complete()),m(p=>F({ref:e},p)))}).pipe(ze(ie))}function Hn(e,{viewport$:t,target$:r,print$:o}){return T(...R(".annotate:not(.highlight)",e).map(n=>wn(n,{target$:r,print$:o})),...R("pre:not(.mermaid) > code",e).map(n=>On(n,{target$:r,print$:o})),...R("pre.mermaid",e).map(n=>_n(n)),...R("table:not([class])",e).map(n=>Cn(n)),...R("details",e).map(n=>Mn(n,{target$:r,print$:o})),...R("[data-tabs]",e).map(n=>kn(n,{viewport$:t,target$:r})),...R("[title]",e).filter(()=>G("content.tooltips")).map(n=>Ge(n)))}function Ra(e,{alert$:t}){return t.pipe(b(r=>T($(!0),$(!1).pipe(Ye(2e3))).pipe(m(o=>({message:r,active:o})))))}function $n(e,t){let r=P(".md-typeset",e);return H(()=>{let o=new v;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),Ra(e,t).pipe(y(n=>o.next(n)),_(()=>o.complete()),m(n=>F({ref:e},n)))})}function Pa({viewport$:e}){if(!G("header.autohide"))return $(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Ke(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),Y()),o=We("search");return Q([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),Y(),b(n=>n?r:$(!1)),q(!1))}function Rn(e,t){return H(()=>Q([Ee(e),Pa(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),Y((r,o)=>r.height===o.height&&r.hidden===o.hidden),B(1))}function Pn(e,{header$:t,main$:r}){return H(()=>{let o=new v,n=o.pipe(ee(),oe(!0));o.pipe(X("active"),je(t)).subscribe(([{active:s},{hidden:a}])=>{e.classList.toggle("md-header--shadow",s&&!a),e.hidden=a});let i=fe(R("[title]",e)).pipe(g(()=>G("content.tooltips")),re(s=>Ge(s)));return r.subscribe(o),t.pipe(U(n),m(s=>F({ref:e},s)),$e(i.pipe(U(n))))})}function Ia(e,{viewport$:t,header$:r}){return pr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=pe(e);return{active:o>=n}}),X("active"))}function In(e,t){return H(()=>{let r=new v;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=me(".md-content h1");return typeof o=="undefined"?L:Ia(o,t).pipe(y(n=>r.next(n)),_(()=>r.complete()),m(n=>F({ref:e},n)))})}function Fn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),Y()),n=o.pipe(b(()=>Ee(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),X("bottom"))));return Q([o,n,t]).pipe(m(([i,{top:s,bottom:a},{offset:{y:c},size:{height:p}}])=>(p=Math.max(0,p-Math.max(0,s-c,i)-Math.max(0,p+c-a)),{offset:s-i,height:p,active:s-i<=c})),Y((i,s)=>i.offset===s.offset&&i.height===s.height&&i.active===s.active))}function Fa(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return $(...e).pipe(re(o=>d(o,"change").pipe(m(()=>o))),q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),B(1))}function jn(e){let t=R("input",e),r=E("meta",{name:"theme-color"});document.head.appendChild(r);let o=E("meta",{name:"color-scheme"});document.head.appendChild(o);let n=At("(prefers-color-scheme: light)");return H(()=>{let i=new v;return i.subscribe(s=>{if(document.body.setAttribute("data-md-color-switching",""),s.color.media==="(prefers-color-scheme)"){let a=matchMedia("(prefers-color-scheme: light)"),c=document.querySelector(a.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");s.color.scheme=c.getAttribute("data-md-color-scheme"),s.color.primary=c.getAttribute("data-md-color-primary"),s.color.accent=c.getAttribute("data-md-color-accent")}for(let[a,c]of Object.entries(s.color))document.body.setAttribute(`data-md-color-${a}`,c);for(let a=0;a{let s=Te("header"),a=window.getComputedStyle(s);return o.content=a.colorScheme,a.backgroundColor.match(/\d+/g).map(c=>(+c).toString(16).padStart(2,"0")).join("")})).subscribe(s=>r.content=`#${s}`),i.pipe(Oe(ie)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),Fa(t).pipe(U(n.pipe(Le(1))),at(),y(s=>i.next(s)),_(()=>i.complete()),m(s=>F({ref:e},s)))})}function Un(e,{progress$:t}){return H(()=>{let r=new v;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(y(o=>r.next({value:o})),_(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Kr=jt(zr());function ja(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Wn({alert$:e}){Kr.default.isSupported()&&new j(t=>{new Kr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||ja(P(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(y(t=>{t.trigger.focus()}),m(()=>ge("clipboard.copied"))).subscribe(e)}function Dn(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function Ua(e,t){let r=new Map;for(let o of R("url",e)){let n=P("loc",o),i=[Dn(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let s of R("[rel=alternate]",o)){let a=s.getAttribute("href");a!=null&&i.push(Dn(new URL(a),t))}}return r}function mr(e){return on(new URL("sitemap.xml",e)).pipe(m(t=>Ua(t,new URL(e))),he(()=>$(new Map)))}function Wa(e,t){if(!(e.target instanceof Element))return L;let r=e.target.closest("a");if(r===null)return L;if(r.target||e.metaKey||e.ctrlKey)return L;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),$(new URL(r.href))):L}function Nn(e){let t=new Map;for(let r of R(":scope > *",e.head))t.set(r.outerHTML,r);return t}function Vn(e){for(let t of R("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return $(e)}function Da(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...G("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=me(o),i=me(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=Nn(document);for(let[o,n]of Nn(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Te("container");return Fe(R("script",r)).pipe(b(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new j(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),L}),ee(),oe(document))}function zn({location$:e,viewport$:t,progress$:r}){let o=we();if(location.protocol==="file:")return L;let n=mr(o.base);$(document).subscribe(Vn);let i=d(document.body,"click").pipe(je(n),b(([c,p])=>Wa(c,p)),le()),s=d(window,"popstate").pipe(m(ve),le());i.pipe(ae(t)).subscribe(([c,{offset:p}])=>{history.replaceState(p,""),history.pushState(null,"",c)}),T(i,s).subscribe(e);let a=e.pipe(X("pathname"),b(c=>rn(c,{progress$:r}).pipe(he(()=>(st(c,!0),L)))),b(Vn),b(Da),le());return T(a.pipe(ae(e,(c,p)=>p)),e.pipe(X("pathname"),b(()=>e),X("hash")),e.pipe(Y((c,p)=>c.pathname===p.pathname&&c.hash===p.hash),b(()=>i),y(()=>history.back()))).subscribe(c=>{var p,l;history.state!==null||!c.hash?window.scrollTo(0,(l=(p=history.state)==null?void 0:p.y)!=null?l:0):(history.scrollRestoration="auto",Zo(c.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),d(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(X("offset"),be(100)).subscribe(({offset:c})=>{history.replaceState(c,"")}),a}var Qn=jt(Kn());function Yn(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,s)=>`${i}${s}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return s=>(0,Qn.default)(s).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function Ht(e){return e.type===1}function fr(e){return e.type===3}function Bn(e,t){let r=ln(e);return T($(location.protocol!=="file:"),We("search")).pipe(He(o=>o),b(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:G("search.suggest")}}})),r}function Gn({document$:e}){let t=we(),r=De(new URL("../versions.json",t.base)).pipe(he(()=>L)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:s,aliases:a})=>s===i||a.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),b(n=>d(document.body,"click").pipe(g(i=>!i.metaKey&&!i.ctrlKey),ae(o),b(([i,s])=>{if(i.target instanceof Element){let a=i.target.closest("a");if(a&&!a.target&&n.has(a.href)){let c=a.href;return!i.target.closest(".md-version")&&n.get(c)===s?L:(i.preventDefault(),$(c))}}return L}),b(i=>{let{version:s}=n.get(i);return mr(new URL(i)).pipe(m(a=>{let p=ve().href.replace(t.base,"");return a.has(p.split("#")[0])?new URL(`../${s}/${p}`,t.base):new URL(i)}))})))).subscribe(n=>st(n,!0)),Q([r,o]).subscribe(([n,i])=>{P(".md-header__topic").appendChild(gn(n,i))}),e.pipe(b(()=>o)).subscribe(n=>{var s;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let a=((s=t.version)==null?void 0:s.default)||"latest";Array.isArray(a)||(a=[a]);e:for(let c of a)for(let p of n.aliases.concat(n.version))if(new RegExp(c,"i").test(p)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let a of ne("outdated"))a.hidden=!1})}function Ka(e,{worker$:t}){let{searchParams:r}=ve();r.has("q")&&(Be("search",!0),e.value=r.get("q"),e.focus(),We("search").pipe(He(i=>!i)).subscribe(()=>{let i=ve();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=vt(e),n=T(t.pipe(He(Ht)),d(e,"keyup"),o).pipe(m(()=>e.value),Y());return Q([n,o]).pipe(m(([i,s])=>({value:i,focus:s})),B(1))}function Jn(e,{worker$:t}){let r=new v,o=r.pipe(ee(),oe(!0));Q([t.pipe(He(Ht)),r],(i,s)=>s).pipe(X("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(X("focus")).subscribe(({focus:i})=>{i&&Be("search",i)}),d(e.form,"reset").pipe(U(o)).subscribe(()=>e.focus());let n=P("header [for=__search]");return d(n,"click").subscribe(()=>e.focus()),Ka(e,{worker$:t}).pipe(y(i=>r.next(i)),_(()=>r.complete()),m(i=>F({ref:e},i)),B(1))}function Xn(e,{worker$:t,query$:r}){let o=new v,n=Yo(e.parentElement).pipe(g(Boolean)),i=e.parentElement,s=P(":scope > :first-child",e),a=P(":scope > :last-child",e);We("search").subscribe(l=>a.setAttribute("role",l?"list":"presentation")),o.pipe(ae(r),Ir(t.pipe(He(Ht)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:s.textContent=f.length?ge("search.result.none"):ge("search.result.placeholder");break;case 1:s.textContent=ge("search.result.one");break;default:let u=ar(l.length);s.textContent=ge("search.result.other",u)}});let c=o.pipe(y(()=>a.innerHTML=""),b(({items:l})=>T($(...l.slice(0,10)),$(...l.slice(10)).pipe(Ke(4),jr(n),b(([f])=>f)))),m(hn),le());return c.subscribe(l=>a.appendChild(l)),c.pipe(re(l=>{let f=me("details",l);return typeof f=="undefined"?L:d(f,"toggle").pipe(U(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(g(fr),m(({data:l})=>l)).pipe(y(l=>o.next(l)),_(()=>o.complete()),m(l=>F({ref:e},l)))}function Qa(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=ve();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function Zn(e,t){let r=new v,o=r.pipe(ee(),oe(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),d(e,"click").pipe(U(o)).subscribe(n=>n.preventDefault()),Qa(e,t).pipe(y(n=>r.next(n)),_(()=>r.complete()),m(n=>F({ref:e},n)))}function ei(e,{worker$:t,keyboard$:r}){let o=new v,n=Te("search-query"),i=T(d(n,"keydown"),d(n,"focus")).pipe(Oe(ie),m(()=>n.value),Y());return o.pipe(je(i),m(([{suggest:a},c])=>{let p=c.split(/([\s-]+)/);if(a!=null&&a.length&&p[p.length-1]){let l=a[a.length-1];l.startsWith(p[p.length-1])&&(p[p.length-1]=l)}else p.length=0;return p})).subscribe(a=>e.innerHTML=a.join("").replace(/\s/g," ")),r.pipe(g(({mode:a})=>a==="search")).subscribe(a=>{switch(a.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(g(fr),m(({data:a})=>a)).pipe(y(a=>o.next(a)),_(()=>o.complete()),m(()=>({ref:e})))}function ti(e,{index$:t,keyboard$:r}){let o=we();try{let n=Bn(o.search,t),i=Te("search-query",e),s=Te("search-result",e);d(e,"click").pipe(g(({target:c})=>c instanceof Element&&!!c.closest("a"))).subscribe(()=>Be("search",!1)),r.pipe(g(({mode:c})=>c==="search")).subscribe(c=>{let p=Re();switch(c.type){case"Enter":if(p===i){let l=new Map;for(let f of R(":first-child [href]",s)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,h])=>h-u);f.click()}c.claim()}break;case"Escape":case"Tab":Be("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof p=="undefined")i.focus();else{let l=[i,...R(":not(details) > [href], summary, details[open] [href]",s)],f=Math.max(0,(Math.max(0,l.indexOf(p))+l.length+(c.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}c.claim();break;default:i!==Re()&&i.focus()}}),r.pipe(g(({mode:c})=>c==="global")).subscribe(c=>{switch(c.type){case"f":case"s":case"/":i.focus(),i.select(),c.claim();break}});let a=Jn(i,{worker$:n});return T(a,Xn(s,{worker$:n,query$:a})).pipe($e(...ne("search-share",e).map(c=>Zn(c,{query$:a})),...ne("search-suggest",e).map(c=>ei(c,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,qe}}function ri(e,{index$:t,location$:r}){return Q([t,r.pipe(q(ve()),g(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>Yn(o.config)(n.searchParams.get("h"))),m(o=>{var s;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let a=i.nextNode();a;a=i.nextNode())if((s=a.parentElement)!=null&&s.offsetHeight){let c=a.textContent,p=o(c);p.length>c.length&&n.set(a,p)}for(let[a,c]of n){let{childNodes:p}=E("span",null,c);a.replaceWith(...Array.from(p))}return{ref:e,nodes:n}}))}function Ya(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return Q([r,t]).pipe(m(([{offset:i,height:s},{offset:{y:a}}])=>(s=s+Math.min(n,Math.max(0,a-i))-n,{height:s,locked:a>=i+n})),Y((i,s)=>i.height===s.height&&i.locked===s.locked))}function Qr(e,o){var n=o,{header$:t}=n,r=to(n,["header$"]);let i=P(".md-sidebar__scrollwrap",e),{y:s}=Ue(i);return H(()=>{let a=new v,c=a.pipe(ee(),oe(!0)),p=a.pipe(Me(0,de));return p.pipe(ae(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*s}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),p.pipe(He()).subscribe(()=>{for(let l of R(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=pe(f);f.scrollTo({top:u-h/2})}}}),fe(R("label[tabindex]",e)).pipe(re(l=>d(l,"click").pipe(Oe(ie),m(()=>l),U(c)))).subscribe(l=>{let f=P(`[id="${l.htmlFor}"]`);P(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),Ya(e,r).pipe(y(l=>a.next(l)),_(()=>a.complete()),m(l=>F({ref:e},l)))})}function oi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return Lt(De(`${r}/releases/latest`).pipe(he(()=>L),m(o=>({version:o.tag_name})),Qe({})),De(r).pipe(he(()=>L),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Qe({}))).pipe(m(([o,n])=>F(F({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return De(r).pipe(m(o=>({repositories:o.public_repos})),Qe({}))}}function ni(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return De(r).pipe(he(()=>L),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Qe({}))}function ii(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return oi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return ni(r,o)}return L}var Ba;function Ga(e){return Ba||(Ba=H(()=>{let t=__md_get("__source",sessionStorage);if(t)return $(t);if(ne("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return L}return ii(e.href).pipe(y(o=>__md_set("__source",o,sessionStorage)))}).pipe(he(()=>L),g(t=>Object.keys(t).length>0),m(t=>({facts:t})),B(1)))}function ai(e){let t=P(":scope > :last-child",e);return H(()=>{let r=new v;return r.subscribe(({facts:o})=>{t.appendChild(bn(o)),t.classList.add("md-source__repository--active")}),Ga(e).pipe(y(o=>r.next(o)),_(()=>r.complete()),m(o=>F({ref:e},o)))})}function Ja(e,{viewport$:t,header$:r}){return Ee(document.body).pipe(b(()=>pr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),X("hidden"))}function si(e,t){return H(()=>{let r=new v;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(G("navigation.tabs.sticky")?$({hidden:!1}):Ja(e,t)).pipe(y(o=>r.next(o)),_(()=>r.complete()),m(o=>F({ref:e},o)))})}function Xa(e,{viewport$:t,header$:r}){let o=new Map,n=R(".md-nav__link",e);for(let a of n){let c=decodeURIComponent(a.hash.substring(1)),p=me(`[id="${c}"]`);typeof p!="undefined"&&o.set(a,p)}let i=r.pipe(X("height"),m(({height:a})=>{let c=Te("main"),p=P(":scope > :first-child",c);return a+.8*(p.offsetTop-c.offsetTop)}),le());return Ee(document.body).pipe(X("height"),b(a=>H(()=>{let c=[];return $([...o].reduce((p,[l,f])=>{for(;c.length&&o.get(c[c.length-1]).tagName>=f.tagName;)c.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let h=f.offsetParent;for(;h;h=h.offsetParent)u+=h.offsetTop;return p.set([...c=[...c,l]].reverse(),u)},new Map))}).pipe(m(c=>new Map([...c].sort(([,p],[,l])=>p-l))),je(i),b(([c,p])=>t.pipe(Rr(([l,f],{offset:{y:u},size:h})=>{let w=u+h.height>=Math.floor(a.height);for(;f.length;){let[,A]=f[0];if(A-p=u&&!w)f=[l.pop(),...f];else break}return[l,f]},[[],[...c]]),Y((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([a,c])=>({prev:a.map(([p])=>p),next:c.map(([p])=>p)})),q({prev:[],next:[]}),Ke(2,1),m(([a,c])=>a.prev.length{let i=new v,s=i.pipe(ee(),oe(!0));if(i.subscribe(({prev:a,next:c})=>{for(let[p]of c)p.classList.remove("md-nav__link--passed"),p.classList.remove("md-nav__link--active");for(let[p,[l]]of a.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",p===a.length-1)}),G("toc.follow")){let a=T(t.pipe(be(1),m(()=>{})),t.pipe(be(250),m(()=>"smooth")));i.pipe(g(({prev:c})=>c.length>0),je(o.pipe(Oe(ie))),ae(a)).subscribe(([[{prev:c}],p])=>{let[l]=c[c.length-1];if(l.offsetHeight){let f=sr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=pe(f);f.scrollTo({top:u-h/2,behavior:p})}}})}return G("navigation.tracking")&&t.pipe(U(s),X("offset"),be(250),Le(1),U(n.pipe(Le(1))),at({delay:250}),ae(i)).subscribe(([,{prev:a}])=>{let c=ve(),p=a[a.length-1];if(p&&p.length){let[l]=p,{hash:f}=new URL(l.href);c.hash!==f&&(c.hash=f,history.replaceState({},"",`${c}`))}else c.hash="",history.replaceState({},"",`${c}`)}),Xa(e,{viewport$:t,header$:r}).pipe(y(a=>i.next(a)),_(()=>i.complete()),m(a=>F({ref:e},a)))})}function Za(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:s}})=>s),Ke(2,1),m(([s,a])=>s>a&&a>0),Y()),i=r.pipe(m(({active:s})=>s));return Q([i,n]).pipe(m(([s,a])=>!(s&&a)),Y(),U(o.pipe(Le(1))),oe(!0),at({delay:250}),m(s=>({hidden:s})))}function pi(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new v,s=i.pipe(ee(),oe(!0));return i.subscribe({next({hidden:a}){e.hidden=a,a?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(U(s),X("height")).subscribe(({height:a})=>{e.style.top=`${a+16}px`}),d(e,"click").subscribe(a=>{a.preventDefault(),window.scrollTo({top:0})}),Za(e,{viewport$:t,main$:o,target$:n}).pipe(y(a=>i.next(a)),_(()=>i.complete()),m(a=>F({ref:e},a)))}function li({document$:e}){e.pipe(b(()=>R(".md-ellipsis")),re(t=>yt(t).pipe(U(e.pipe(Le(1))),g(r=>r),m(()=>t),ye(1))),g(t=>t.offsetWidth{let r=t.innerText,o=t.closest("a")||t;return o.title=r,Ge(o).pipe(U(e.pipe(Le(1))),_(()=>o.removeAttribute("title")))})).subscribe(),e.pipe(b(()=>R(".md-status")),re(t=>Ge(t))).subscribe()}function mi({document$:e,tablet$:t}){e.pipe(b(()=>R(".md-toggle--indeterminate")),y(r=>{r.indeterminate=!0,r.checked=!1}),re(r=>d(r,"change").pipe(Fr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),ae(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function es(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function fi({document$:e}){e.pipe(b(()=>R("[data-md-scrollfix]")),y(t=>t.removeAttribute("data-md-scrollfix")),g(es),re(t=>d(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function ui({viewport$:e,tablet$:t}){Q([We("search"),t]).pipe(m(([r,o])=>r&&!o),b(r=>$(r).pipe(Ye(r?400:100))),ae(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function ts(){return location.protocol==="file:"?gt(`${new URL("search/search_index.js",Yr.base)}`).pipe(m(()=>__index),B(1)):De(new URL("search/search_index.json",Yr.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var rt=No(),Rt=Jo(),wt=en(Rt),Br=Go(),_e=pn(),ur=At("(min-width: 960px)"),hi=At("(min-width: 1220px)"),bi=tn(),Yr=we(),vi=document.forms.namedItem("search")?ts():qe,Gr=new v;Wn({alert$:Gr});var Jr=new v;G("navigation.instant")&&zn({location$:Rt,viewport$:_e,progress$:Jr}).subscribe(rt);var di;((di=Yr.version)==null?void 0:di.provider)==="mike"&&Gn({document$:rt});T(Rt,wt).pipe(Ye(125)).subscribe(()=>{Be("drawer",!1),Be("search",!1)});Br.pipe(g(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=me("link[rel=prev]");typeof t!="undefined"&&st(t);break;case"n":case".":let r=me("link[rel=next]");typeof r!="undefined"&&st(r);break;case"Enter":let o=Re();o instanceof HTMLLabelElement&&o.click()}});li({document$:rt});mi({document$:rt,tablet$:ur});fi({document$:rt});ui({viewport$:_e,tablet$:ur});var tt=Rn(Te("header"),{viewport$:_e}),$t=rt.pipe(m(()=>Te("main")),b(e=>Fn(e,{viewport$:_e,header$:tt})),B(1)),rs=T(...ne("consent").map(e=>fn(e,{target$:wt})),...ne("dialog").map(e=>$n(e,{alert$:Gr})),...ne("header").map(e=>Pn(e,{viewport$:_e,header$:tt,main$:$t})),...ne("palette").map(e=>jn(e)),...ne("progress").map(e=>Un(e,{progress$:Jr})),...ne("search").map(e=>ti(e,{index$:vi,keyboard$:Br})),...ne("source").map(e=>ai(e))),os=H(()=>T(...ne("announce").map(e=>mn(e)),...ne("content").map(e=>Hn(e,{viewport$:_e,target$:wt,print$:bi})),...ne("content").map(e=>G("search.highlight")?ri(e,{index$:vi,location$:Rt}):L),...ne("header-title").map(e=>In(e,{viewport$:_e,header$:tt})),...ne("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Ur(hi,()=>Qr(e,{viewport$:_e,header$:tt,main$:$t})):Ur(ur,()=>Qr(e,{viewport$:_e,header$:tt,main$:$t}))),...ne("tabs").map(e=>si(e,{viewport$:_e,header$:tt})),...ne("toc").map(e=>ci(e,{viewport$:_e,header$:tt,main$:$t,target$:wt})),...ne("top").map(e=>pi(e,{viewport$:_e,header$:tt,main$:$t,target$:wt})))),gi=rt.pipe(b(()=>os),$e(rs),B(1));gi.subscribe();window.document$=rt;window.location$=Rt;window.target$=wt;window.keyboard$=Br;window.viewport$=_e;window.tablet$=ur;window.screen$=hi;window.print$=bi;window.alert$=Gr;window.progress$=Jr;window.component$=gi;})();
+//# sourceMappingURL=bundle.bd41221c.min.js.map
+
diff --git a/assets/javascripts/bundle.bd41221c.min.js.map b/assets/javascripts/bundle.bd41221c.min.js.map
new file mode 100644
index 0000000..1663dab
--- /dev/null
+++ b/assets/javascripts/bundle.bd41221c.min.js.map
@@ -0,0 +1,7 @@
+{
+ "version": 3,
+ "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/clipboard/dist/clipboard.js", "node_modules/escape-html/index.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/rxjs/node_modules/tslib/tslib.es6.js", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"],
+ "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*\n * Copyright (c) 2016-2024 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/*! *****************************************************************************\r\nCopyright (c) Microsoft Corporation.\r\n\r\nPermission to use, copy, modify, and/or distribute this software for any\r\npurpose with or without fee is hereby granted.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\r\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\r\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\r\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\r\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\r\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\r\nPERFORMANCE OF THIS SOFTWARE.\r\n***************************************************************************** */\r\n/* global Reflect, Promise */\r\n\r\nvar extendStatics = function(d, b) {\r\n extendStatics = Object.setPrototypeOf ||\r\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\r\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\r\n return extendStatics(d, b);\r\n};\r\n\r\nexport function __extends(d, b) {\r\n if (typeof b !== \"function\" && b !== null)\r\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\r\n extendStatics(d, b);\r\n function __() { this.constructor = d; }\r\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\r\n}\r\n\r\nexport var __assign = function() {\r\n __assign = Object.assign || function __assign(t) {\r\n for (var s, i = 1, n = arguments.length; i < n; i++) {\r\n s = arguments[i];\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\r\n }\r\n return t;\r\n }\r\n return __assign.apply(this, arguments);\r\n}\r\n\r\nexport function __rest(s, e) {\r\n var t = {};\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\r\n t[p] = s[p];\r\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\r\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\r\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\r\n t[p[i]] = s[p[i]];\r\n }\r\n return t;\r\n}\r\n\r\nexport function __decorate(decorators, target, key, desc) {\r\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\r\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\r\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\r\n return c > 3 && r && Object.defineProperty(target, key, r), r;\r\n}\r\n\r\nexport function __param(paramIndex, decorator) {\r\n return function (target, key) { decorator(target, key, paramIndex); }\r\n}\r\n\r\nexport function __metadata(metadataKey, metadataValue) {\r\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\r\n}\r\n\r\nexport function __awaiter(thisArg, _arguments, P, generator) {\r\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\r\n return new (P || (P = Promise))(function (resolve, reject) {\r\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\r\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\r\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\r\n step((generator = generator.apply(thisArg, _arguments || [])).next());\r\n });\r\n}\r\n\r\nexport function __generator(thisArg, body) {\r\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;\r\n return g = { next: verb(0), \"throw\": verb(1), \"return\": verb(2) }, typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\r\n function verb(n) { return function (v) { return step([n, v]); }; }\r\n function step(op) {\r\n if (f) throw new TypeError(\"Generator is already executing.\");\r\n while (_) try {\r\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\r\n if (y = 0, t) op = [op[0] & 2, t.value];\r\n switch (op[0]) {\r\n case 0: case 1: t = op; break;\r\n case 4: _.label++; return { value: op[1], done: false };\r\n case 5: _.label++; y = op[1]; op = [0]; continue;\r\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\r\n default:\r\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\r\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\r\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\r\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\r\n if (t[2]) _.ops.pop();\r\n _.trys.pop(); continue;\r\n }\r\n op = body.call(thisArg, _);\r\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\r\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\r\n }\r\n}\r\n\r\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });\r\n}) : (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n o[k2] = m[k];\r\n});\r\n\r\nexport function __exportStar(m, o) {\r\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\r\n}\r\n\r\nexport function __values(o) {\r\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\r\n if (m) return m.call(o);\r\n if (o && typeof o.length === \"number\") return {\r\n next: function () {\r\n if (o && i >= o.length) o = void 0;\r\n return { value: o && o[i++], done: !o };\r\n }\r\n };\r\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\r\n}\r\n\r\nexport function __read(o, n) {\r\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\r\n if (!m) return o;\r\n var i = m.call(o), r, ar = [], e;\r\n try {\r\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\r\n }\r\n catch (error) { e = { error: error }; }\r\n finally {\r\n try {\r\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\r\n }\r\n finally { if (e) throw e.error; }\r\n }\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spread() {\r\n for (var ar = [], i = 0; i < arguments.length; i++)\r\n ar = ar.concat(__read(arguments[i]));\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spreadArrays() {\r\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\r\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\r\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\r\n r[k] = a[j];\r\n return r;\r\n}\r\n\r\nexport function __spreadArray(to, from, pack) {\r\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\r\n if (ar || !(i in from)) {\r\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\r\n ar[i] = from[i];\r\n }\r\n }\r\n return to.concat(ar || Array.prototype.slice.call(from));\r\n}\r\n\r\nexport function __await(v) {\r\n return this instanceof __await ? (this.v = v, this) : new __await(v);\r\n}\r\n\r\nexport function __asyncGenerator(thisArg, _arguments, generator) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\r\n return i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i;\r\n function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }\r\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\r\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\r\n function fulfill(value) { resume(\"next\", value); }\r\n function reject(value) { resume(\"throw\", value); }\r\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\r\n}\r\n\r\nexport function __asyncDelegator(o) {\r\n var i, p;\r\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\r\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === \"return\" } : f ? f(v) : v; } : f; }\r\n}\r\n\r\nexport function __asyncValues(o) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var m = o[Symbol.asyncIterator], i;\r\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\r\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\r\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\r\n}\r\n\r\nexport function __makeTemplateObject(cooked, raw) {\r\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\r\n return cooked;\r\n};\r\n\r\nvar __setModuleDefault = Object.create ? (function(o, v) {\r\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\r\n}) : function(o, v) {\r\n o[\"default\"] = v;\r\n};\r\n\r\nexport function __importStar(mod) {\r\n if (mod && mod.__esModule) return mod;\r\n var result = {};\r\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\r\n __setModuleDefault(result, mod);\r\n return result;\r\n}\r\n\r\nexport function __importDefault(mod) {\r\n return (mod && mod.__esModule) ? mod : { default: mod };\r\n}\r\n\r\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\r\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\r\n}\r\n\r\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\r\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\r\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\r\n}\r\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber