setting keywords for the .select() method

[gswifort]

Is it possible to set keywords for the Ed.Editor.select() method? Calling .initGet() before .select() has no effect - only standard keywords are available, as with the SELECT command. However, built-in tools have additional command-specific keywords - e.g. MATCHPROP has SETTINGS.

[CEXT-Dan]

Not currently, acedSSGet uses callbacks which are a bit difficult to wrap, so I skipped over it. To give you an idea, from a C++ perspective, it would be something like this:

    static struct resbuf* myKeywordCallback(const ACHAR* pcKey) 
    {
        acutPrintf(L"\nKey='%s'", pcKey);
        // manually create a selection set
        return nullptr;
    }

    static void AcRxPyApp_idoit1(void)
    {
        ads_name sset = { 0,0 };
        struct resbuf* (*pOldCallback)(const ACHAR*) = NULL;

        LPCWSTR promptsKW[] = {
            L"My select objects [Item/Element]: ",
            L"My remove objects [Item/Element]: "
        };
        WCHAR KeyWords[256] = L"Item Element _ 1 2";

        int stat = acedSSGetKwordCallbackPtr(&pOldCallback);
        stat = acedSSSetKwordCallbackPtr(myKeywordCallback);

        stat = acedSSGet(L":$:K", promptsKW, KeyWords, NULL, sset);
        if (stat == RTNORM)
            acedSSFree(sset);
        stat = acedSSSetKwordCallbackPtr(pOldCallback);
    }

I can try to wrap it into the SelectionSet class, it would take some time

[gswifort]

it would be very useful

[CEXT-Dan]

here's a prototype

import traceback
from pyrx import Ap, Db, Ed, Ge, Rx

# return a resbuf or None
# a resbuf of objectids
# a resbuf with error message
# if callback is not called, it's Likely you hit a built in kw
def callback(key: str):
    print("callback", key)
    db = Db.curDb()

    rb = []
    if key == "1":
        model = db.modelSpace()
        for id in model.objectIds(Db.Line.desc()):
            rb.append((Rx.LispType.kObjectId, id))
        return rb
    elif key == "2":
        model = db.modelSpace()
        for id in model.objectIds(Db.Circle.desc()):
            rb.append((Rx.LispType.kObjectId, id))
        return rb
    elif key == "3":
        ps, ss = Ed.Editor.selectAll()
        if ps != Ed.PromptStatus.eNormal:
            rb.append((Rx.LispType.kText, "ERROR of Oof:"))
            return rb
        for id in ss.objectIds():
            rb.append((Rx.LispType.kObjectId, id))
        return rb


@Ap.Command()
def doit2():
    try:
        keyWords = "LIne CIrcle GEt _ 1 2 3"
        promptsKW = (
            "Add objects [LIne/CIrcle/GEt]: ",
            "Remove objects [LIne/CIrcle/GEt]: ",
        )
        ps, ss = Ed.Editor.ssgetkw(":$:K", promptsKW, keyWords, [], callback)
        print(ps, ss.size())
    except Exception:
        print(traceback.format_exc())

Command: DOIT2
Add objects [LIne/CIrcle/GEt]: LI
callback 1
4 found
Add objects [LIne/CIrcle/GEt]: CI
callback 2
4 found, 8 total
Add objects [LIne/CIrcle/GEt]: GE
callback 3
8 found (8 duplicate), 8 total
Add objects [LIne/CIrcle/GEt]: R
Remove objects [LIne/CIrcle/GEt]: LI
callback 1
4 found, 4 removed, 4 total
Remove objects [LIne/CIrcle/GEt]: CI
callback 2
4 found, 4 removed, 0 total
Remove objects [LIne/CIrcle/GEt]: GE
callback 3
8 found, 0 total
Remove objects [LIne/CIrcle/GEt]: A
Add objects [LIne/CIrcle/GEt]: LI
callback 1
4 found, 4 total
Add objects [LIne/CIrcle/GEt]: *Cancel*
eCancel 0

[CEXT-Dan]

I added a preview build in b1a70bb

[CEXT-Dan]

The callback in the release will be different, I build the resbuf in C++, so just return the value

import traceback
from pyrx import Ap, Db, Ed, Ge, Rx


# return objectids, an error message or none
# if callback is not called, it's Likely you hit a built in kw
def callback(key: str):
    print("callback", key)
    db = Db.curDb()
    if key == "1":
        model = db.modelSpace()
        return model.objectIds(Db.Line.desc())
    elif key == "2":
        model = db.modelSpace()
        return model.objectIdArray(Db.Circle.desc())
    elif key == "3":
        ps, ss = Ed.Editor.selectAll()
        if ps != Ed.PromptStatus.eNormal:
            return "ERROR of Oof:"
        return ss.objectIds()

@Ap.Command()
def doit():
    try:
        keyWords = "LIne CIrcle GEt _ 1 2 3"
        promptsKW = (
            "Add objects [LIne/CIrcle/GEt]: ",
            "Remove objects [LIne/CIrcle/GEt]: ",
        )
        ps, ss = Ed.Editor.ssgetkw(":$:K", promptsKW, keyWords, [], callback)
        print(ps, ss.size())
    except Exception:
        print(traceback.format_exc())

[CEXT-Dan]

added acedSSGetOtherCallbackPtr, note the mode string ":$:K:?"

def callback(key: str):
    print("callback", key)
    db = Db.curDb()
    if key == "1":
        model = db.modelSpace()
        return model.objectIds(Db.Line.desc())
    elif key == "2":
        model = db.modelSpace()
        return model.objectIdArray(Db.Circle.desc())
    elif key == "3":
        ps, ss = Ed.Editor.selectAll()
        if ps != Ed.PromptStatus.eNormal:
            return "ERROR of Oof:"
        return ss.objectIds()


def othercallback(key: str):
    print("othercallback", key)
    if key.casefold() == "FU".casefold():
        ps, ss = Ed.Editor.selectAll()
        if ps != Ed.PromptStatus.eNormal:
            return "ERROR of Oof:"
        return ss.objectIds()


@Ap.Command()
def pyssgetkwo():
    try:
        keyWords = "LIne CIrcle GEt _ 1 2 3"
        promptsKW = (
            "Add objects [LIne/CIrcle/GEt]: ",
            "Remove objects [LIne/CIrcle/GEt]: ",
        )
        ps, ss = Ed.Editor.ssgetkw(":$:K:?", promptsKW, keyWords, [], callback, othercallback)
        print(ps, ss.size())
    except Exception:
        print(traceback.format_exc())

[gswifort]

Can I use it this way?
It works, but do you see any potential issues?

from pyrx import Ed, command


@command
def doit():
    prompts = ("Add objects or [Raise]: ", "Remove objects or [Raise]: ")
    kwords = "Raise _ 1"
    try:
        status, sset = Ed.Editor.ssgetkw(":$:K", prompts, kwords, [], callback)
    except MyException as e:
        print("User exception caught in command:", e)
    else:
        print(status, sset.size())


def callback(key: str):
    if key == "1":
        print("Raising exception from callback")
        raise MyException("This is a test exception raised from the callback")


class MyException(Exception):
    pass

[CEXT-Dan]

I would say it’s not a good idea to throw an exception back into C++, it unwinds the stack, I should probably add a guard against this.

[CEXT-Dan]

The release build will catch exceptions, otherwise the internal selection set may leak. There’s a limited number of selection sets (256), so allowing exceptions to fall through could eventually cause a crash

[gswifort]

1. When using the entsel, entering a keyword changes the program flow. Currently, I can't do the same with ssget - after calling callback, ssget returns to the loop. Is it possible to interrupt the ssget command?

For example:

• callback returns an empty list → ssget returns to the loop without adding any objects,
• callback returns None → the ssget loop is interrupted

from pyrx import Db, Ed, command


@command
def doit():
    Ed.Editor.initGet(0, "C _ 1")
    status, obj_id, _ = Ed.Editor.entSel("\nSelect an entity or [Continue]: ")
    if status == Ed.PromptStatus.eKeyword:
        kword = Ed.Editor.getInput()
        if kword == "1":
            change_program_flow()
    elif status != Ed.PromptStatus.eOk:
        print(status)
    else:
        process_obj_id(obj_id)


@command
def doit1():
    prompts = ("Select objects or [Continue]: ", "Remove objects or [Continue]: ")

    def callback(key: str):
        if key == "1":
            change_program_flow()

    status, sset = Ed.Editor.ssgetkw(":$:K", prompts, "C _ 1", [], callback)
    if status != Ed.PromptStatus.eOk:
        print(status)
    else:
        process_sset(sset)


def change_program_flow():
    print("Changing program flow...")


def process_obj_id(obj_id: Db.ObjectId):
    print(f"Processing object id: {obj_id.handle().toString()}")


def process_sset(sset: Ed.SelectionSet):
    print(f"Processing selection set with {sset.size()} entities")

2. Can I remove something from the SelectionSet using callback?

[CEXT-Dan]

1, In AutoCAD you would use Ed.Core.postCommand("\x03\x03") , doesn;t seem to work in zw, since it's waiting for keyboard, maybe this will work.

def change_program_flow():
    print("Changing program flow...")
    ctypes.windll.user32.PostMessageW(Ap.curDoc().docWnd(), 0x0102, 0x0D, 0)
    #Ed.Core.postCommand("\x03\x03")

2, I don't know, I use R keyword to let the user remove objects.

[CEXT-Dan]

sending escape is probably better. the above was return

WM_KEYDOWN = 0x0100
VK_ESCAPE = 0x001B

def change_program_flow():
    print("Changing program flow...")
    hwnd = Ap.curDoc().docWnd()
    ctypes.windll.user32.PostMessageW(hwnd, WM_KEYDOWN, VK_ESCAPE, 0)

[CEXT-Dan]

A side note, [Continue] conflicts with Crossing, you’ll need to capitalize enough letters to break the conflict.

 prompts = ("Select objects or [COntinue]: ", "Remove objects or [COntinue]: ")
    def callback(key: str):
        if key == "1":
            change_program_flow()
    status, sset = Ed.Editor.ssgetkw(":$:K", prompts, "COntinue _ 1", [], callback)
...

[CEXT-Dan]

I think I found a way to safely get the selection set garbage collected in case of exception, I can see my PyEdSSDeleter function being called. At least you wouldn’t be leaking selection sets. However, I can’t see the call stack inside AutoCAD. There’s a ton of moving parts inside acedSSGet, I.e. all of the events that fire on selections set ending.

I would venture to say that AutoCAD’s code pretty robust here, it’s a high-risk area, i.e. people switching documents during a selection set , all the funky tricks autolisp coders do.

In short, I can let exceptions pass, but it’s undefined behavior, Y/N?

[gswifort]

I think so. The user can always wrap their code in a try/except block.
[ Y ]

[CEXT-Dan]

Ok, I'll make a new build, I ran this test, I could not detect any issues

from pyrx import Ed, Rx, command

@command
def doit():
    prompts = ("Add objects or [RAise]: ", "Remove objects or [RAise]: ")
    kwords = "RAise _ 1"
    try:
        status, sset = Ed.Editor.ssgetkw(":$:K", prompts, kwords, [], callback)
    except MyException as e:
        print("User exception caught in command:", e)
    else:
        print(status, sset.size())

def callback(key: str):
    if key == "1":
        print("Raising exception from callback")
        raise MyException("This is a test exception raised from the callback")

class MyException(Exception):
    pass

@command
def nukeit():
    try:
        resbuf = [
            (Rx.LispType.kText, "doit"),
            (Rx.LispType.kText, "RA"),
            (Rx.LispType.kNone, 0),
        ]
        for i in range(1024):
            Ed.Core.cmdS(resbuf)
    except Exception as err:
        print(err)

[gswifort]

:$:K:?"

Where did these flags come from? I looked here

[CEXT-Dan]

here I don't think lisp has these. I don't think .NET has them either.
I haven't tried all the combinations, some like X:$:K:? or X:$:K:? may return eRejected

[CEXT-Dan]

I added this for convenience, mode :$:K:? is in the wrapper so people don't have to remember them.
ssget, ssgetkw can be used for some custom behaviors.

    @staticmethod
    def selectKeyword(
        promptsKW: tuple[str, str],
        keyWords: str,
        filter: Collection[tuple[int, Any]],
        callback: Any,
        otherCallback: Any = ...,
        /,
    ) -> tuple[PyEd.PromptStatus, PyEd.SelectionSet]: