From patchwork Tue Aug 20 17:10:30 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Burgess X-Patchwork-Id: 57370 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id C63A938425AF for ; Tue, 20 Aug 2024 17:11:30 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by sourceware.org (Postfix) with ESMTP id 046D7384477A for ; Tue, 20 Aug 2024 17:10:51 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 046D7384477A Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 046D7384477A Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.129.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1724173853; cv=none; b=FVQ8beUmEx5rdWTXS6+nwQ7Rxsnxr5tjEZoXOwsmzrqL77K4th93VFGoE7RvRnGiVoGN6ll2Dd8soQ48M4QTVGhZYokRQ8q39AtGeoLyIqkO/a3YKGa0qlR/DtC0Gj6ixWYJ5fget48KhEROsy3Hr2njdpbUE6eRob8BxGkpZGc= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1724173853; c=relaxed/simple; bh=0NPAqqn/JA29IqzbUmIfyT3piCuFqXrCIm+P91HofBM=; h=DKIM-Signature:From:To:Subject:Date:Message-Id:MIME-Version; b=PbcF2OvRSb+uc4s8MoTFWiIcughptXMhYFGkAA84FN7sKJHu+ZItTod0pDPJRClbkxAd/Fd/5pez4AbyS8NQpLhYPyq+38theYWoG3YlRUFImD/liWmW+mjonXxzuh7ibir1nuArxi7u7pCQiS8Lx4FcudEcKaJ+qQh5m1NPTv0= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1724173851; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=s9be8fVrP6yNgUmrEVKBt/K2b2S66/zl2BoB7oFxvKU=; b=L3vyXtA7Wr9xM+uS7Vc0eMbE/Z6g6w0cT4HOiL+fKy0Icx0+44Y7/k8RYqFIJhK+TjQHcw JR/jksyLAC/10KsLb9cB4Sr+opRk4ExSSxpfJ3p+jq4xd87EDM5oiJX9Ad/pVITKkLjDTR an6ub4JPlaLmC27nFTy+3LDmj51BwHE= Received: from mail-wm1-f70.google.com (mail-wm1-f70.google.com [209.85.128.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-149-RzAQAgQ_NKqvjs2zIZIv_g-1; Tue, 20 Aug 2024 13:10:50 -0400 X-MC-Unique: RzAQAgQ_NKqvjs2zIZIv_g-1 Received: by mail-wm1-f70.google.com with SMTP id 5b1f17b1804b1-429c224d9edso50096975e9.1 for ; Tue, 20 Aug 2024 10:10:49 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724173847; x=1724778647; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=s9be8fVrP6yNgUmrEVKBt/K2b2S66/zl2BoB7oFxvKU=; b=CtwA4fDyF67Recdz/A6ulO+Zktx2ZL1rhBSw0adQHbjSk3qzZXpzBTj5+ESKK/jOUR o9ZhWIjtWZXQSTFC3WxYw3ObZbYRilw/GYbet6aK7exCywA4wukCgQOrXZXqJGI9K2XN aKV1C4PTfLvm6ecaTQOEGbLiHYoN/Z7FRDF06MyKiGb5YAAk+gHsfLO8Zj5IoYNSrv5t d4qusyDmXNsVNI9FALwGvN2wa1Nc/G7SIIRdXvzidWVIZegClTdP7niWFkW0VgoU3dzd Rzukt7CB1GKwnnJphscH4UuuOUP+RgPyYLI28mHN+pCzM1cQ1Zk7AG3ZPCObIBmMIa3N B/xw== X-Gm-Message-State: AOJu0Yxvct1l0t9Be/56VMH91zfmy+Df5eFPZHQ7mTnFdRuAGVlO4LEM wmK7j7Mg7mrrHOia3pqcEjheGL3pwVeTwj9TT0HVeKbNlGGLF8RBgFpQcYjSrZXM60zvkNsyO7b RWvsAP+XvyEFdDstXFYOVFdEXPog7gHuN6/7aWgezITbJgTO6psGVxgn0jM3FcK/d8z0qQnkvw5 HLhcL+SgKqnJJE4/0OKqBWS/3sESrKWWqIRe43NDCfkjA= X-Received: by 2002:a05:600c:45d1:b0:426:68dd:bc92 with SMTP id 5b1f17b1804b1-42abd11215bmr359055e9.5.1724173846722; Tue, 20 Aug 2024 10:10:46 -0700 (PDT) X-Google-Smtp-Source: AGHT+IH+0ukEV8xDcKshlFrW8+WpeLyJFteSY/UNp0jyem1JdmzaS87BxasBgSjbZfppk9U5snriqw== X-Received: by 2002:a05:600c:45d1:b0:426:68dd:bc92 with SMTP id 5b1f17b1804b1-42abd11215bmr358685e9.5.1724173845690; Tue, 20 Aug 2024 10:10:45 -0700 (PDT) Received: from localhost (178.126.90.146.dyn.plus.net. [146.90.126.178]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-429ded29fcfsm204577825e9.20.2024.08.20.10.10.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 20 Aug 2024 10:10:45 -0700 (PDT) From: Andrew Burgess To: gdb-patches@sourceware.org Cc: Andrew Burgess Subject: [PATCHv5 00/14] Further filename completion improvements Date: Tue, 20 Aug 2024 18:10:30 +0100 Message-Id: X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-2.9 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, RCVD_IN_BARRACUDACENTRAL, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces~patchwork=sourceware.org@sourceware.org In v5: - Rebased onto current master. Very minor merge conflict. Resolved and re-tested with no regressions. - Addressed Eli's doc feedback for patches #12 and #13. In V4: - Tom asked about V3: "...did you consider changing gdb to have a single way to pass a filename to a command?". Well, I've not done that. But, I have ensured that doing this would be possible in the future, and I've added two patches (the last two) that change a few commands. There are two reasons for no changing everyhing in this series, first I'd probably not change all commands in one commit, that one commit would be huge, so chaning all the commits would add even more commits to this already large series. And second, changing the commands is a breaking change, while just chaning the completion (in line with current command behaviour) is non-breaking. - As such, if folk get nervous about changing the command behaviour, the last two patches of V4 should be considered optional. Patches 1 to 12 are all either new functionality, or non-breaking fixes to existing functionality. If the final two patches are accepted then I would plan to write patches to change all the other commands to accept quoted filenames for arguments. That would be my intention, but of course, this series should be reviewed and accepted or rejected assuming the follow up work never arrives. Personally, I'm OK with that, we currently have two style of filename passing. All I do in this series is acknoweldge that and update the completion to handle it. Keeping a single filename completion function (a) doesn't change the fact that we have two filename argument styles, and (b) ensures that completion for one type of argument will remain broken. - I've restructured patches #1 and #2, I've tried to reduce the size of patch #1, while patch #2 is a simple renaming patch. - Patches #3 to #8 are largely unchanged from v3 -- minor tweaks to accomodate changes in earlier patches only. - Patches #9 onwards are new work. - I think that there is additional refactoring and cleanup that could be performed in the area of filename completion, but I've resisted adding that to this series. How that cleanup would progress would depend on whether I get all commands updated to accept quoted filenames or not. I didn't want to invest a large block of time assuming that I could get such a change into GDB only to have it rejected. If we decide to keep the existing two argumet style approach then I think there are other cleanups we could potentially make in the future. In V3: - Patch #1 from the v2 series was merged. - Remaining patches have been rebased and retested. In V2: - Patches #1 and #2 are new in this iteration. Patches #3 to #8 are the patches from V1 rebased onto these two new patches, - Patch #1 adds documentation for the formatting of filename arguments, this tries to explain the two diffent ways that GDB expects filename arguments to be formatted. - Patch #2 addresses the problem that Lancelot pointed out: some commands don't expect filename arguments to be quoted, or to contain escapes. In this patch I split the filename completion in two so the two different filename argument formats are handled separately... - This clears the way for the rest of the series, which updates how completion works for those filename arguments that do accept quoting and escaping, - Patches #3 to #8 are in principle the same as in V1, but there were some changes after rebasing onto the new patch #2. --- Andrew Burgess (14): gdb: split apart two different types of filename completion gdb: deprecated filename_completer and associated functions gdb: improve escaping when completing filenames gdb: move display of completion results into completion_result class gdb: simplify completion_result::print_matches gdb: add match formatter mechanism for 'complete' command output gdb: apply escaping to filenames in 'complete' results gdb: improve gdb_rl_find_completion_word for quoted words gdb: implement readline rl_directory_rewrite_hook callback gdb: new extract_single_filename_arg helper function gdb: extend completion of quoted filenames to work in brkchars phase gdb: add remove-symbol-file command completion gdb: allow quoted filenames for commands that have custom completion gdb: 'target ...' commands now expect quoted/escaped filenames gdb/NEWS | 21 + gdb/auto-load.c | 4 +- gdb/breakpoint.c | 4 +- gdb/cli/cli-cmds.c | 35 +- gdb/cli/cli-decode.c | 8 +- gdb/cli/cli-dump.c | 6 +- gdb/compile/compile.c | 11 +- gdb/completer.c | 643 +++++++++++++++--- gdb/completer.h | 90 ++- gdb/corefile.c | 3 +- gdb/corelow.c | 24 +- gdb/doc/gdb.texinfo | 19 + gdb/dwarf2/index-write.c | 8 +- gdb/exec.c | 12 +- gdb/guile/scm-cmd.c | 2 +- gdb/infcmd.c | 12 +- gdb/inferior.c | 2 +- gdb/jit.c | 2 +- gdb/python/py-cmd.c | 2 +- gdb/record-full.c | 4 +- gdb/record.c | 2 +- gdb/skip.c | 2 +- gdb/source.c | 2 +- gdb/symfile.c | 120 +++- gdb/target-descriptions.c | 31 +- gdb/testsuite/gdb.base/batch-exit-status.exp | 4 +- .../gdb.base/filename-completion.exp | 319 +++++++-- gdb/testsuite/gdb.base/sym-file.exp | 258 +++---- gdb/testsuite/gdb.compile/compile.exp | 2 +- gdb/testsuite/lib/gdb.exp | 10 + gdb/tracectf.c | 12 +- gdb/tracefile-tfile.c | 17 +- gdb/utils.c | 18 + gdb/utils.h | 14 + 34 files changed, 1329 insertions(+), 394 deletions(-) base-commit: 40a1603112d2b1d330e11792b5506457d5584648