Skip to content

WIP: Add timerexistsname and utimerexistsname Tcl commands to check timer existence #1807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ZarTek-Creole wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

WIP: Add timerexistsname and utimerexistsname Tcl commands to check timer existence #1807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bc4fef4
feat(tcl): add timerexists and utimerexists commands
ZarTek-Creole Apr 10, 2025
41147db
`tclmisc.c: Replace Tcl_AppendResult with Tcl_SetResult in tcl_timere…
ZarTek-Creole Apr 11, 2025
3aa8ed0
DOCS: `Added timerexists and utimerexists commands to core module`
ZarTek-Creole Apr 11, 2025
b0631d5
rename to timerexistsname and utimerexistsname
ZarTek-Creole Apr 22, 2025
2e888c2
Merge branch 'eggheads:develop' into develop
ZarTek-Creole Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions doc/sphinx_source/using/tcl-commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2359,6 +2359,46 @@ utimer <seconds> <tcl-command> [count [timerName]]

Module: core

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
timerexistsname <timerName>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Description: Checks if a named minutely timer exists.

Returns:
- "1" if the timer exists
- "0" if the timer doesn't exist

Examples:
```tcl
# Check timer existence
if {[timerexistsname "mytimer"]} {
putlog "Timer 'mytimer' exists"
}
```

Module: core

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
utimerexistsname <timerName>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Description: Checks if a named secondly timer (utimer) exists.

Returns:
- "1" if the utimer exists
- "0" if the utimer doesn't exist

Examples:
```tcl
# Check utimer existence
if {![utimerexistsname "myutimer"]} {
utimer 30 [list do_something] 0 "myutimer"
}
```

Module: core

^^^^^^
timers
^^^^^^
Expand Down
25 changes: 25 additions & 0 deletions src/tclmisc.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,29 @@ static int tcl_utimer STDVAR
Tcl_AppendResult(irp, x, NULL);
return TCL_OK;
}
static int tcl_timerexistsname STDVAR
{
BADARGS(2, 2, " timerName");

if (find_timer(timer, argv[1])) {
Copy link
Member

@michaelortmann michaelortmann Apr 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tcl_AppendResult() is deprecated. Use Tcl_SetResult() if you can. You could do a one-liner, something like:

Tcl_SetResult(interp, find_timer(timer, argv[1]) ? "1" : "0", TCL_STATIC);

Tcl_SetResult(irp, "1", TCL_STATIC);
} else {
Tcl_SetResult(irp, "0", TCL_STATIC);
}
return TCL_OK;
}

static int tcl_utimerexistsname STDVAR
{
BADARGS(2, 2, " utimerName");

if (find_timer(utimer, argv[1])) {
Tcl_SetResult(irp, "1", TCL_STATIC);
} else {
Tcl_SetResult(irp, "0", TCL_STATIC);
}
return TCL_OK;
}

static int tcl_killtimer STDVAR
{
Expand Down Expand Up @@ -822,6 +845,8 @@ tcl_cmds tclmisc_cmds[] = {
{"putloglev", tcl_putloglev},
{"timer", tcl_timer},
{"utimer", tcl_utimer},
{"timerexistsname", tcl_timerexistsname},
{"utimerexistsname", tcl_utimerexistsname},
{"killtimer", tcl_killtimer},
{"killutimer", tcl_killutimer},
{"timers", tcl_timers},
Expand Down
Loading