Skip to content

Update swift-demangle to interactively demangle #4412

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.

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

Merged
merged 1 commit into from
Aug 23, 2016
Merged

Update swift-demangle to interactively demangle #4412

merged 1 commit into from
Aug 23, 2016

Conversation

keith
Copy link
Member

@keith keith commented Aug 19, 2016

What's in this pull request?

This updates swift-demangle's interactive stdin mode to immediately output demangled strings as opposed to waiting until ctrl-d is pressed.

Resolved bug number: (SR-2410)


Before merging this pull request to apple/swift repository:

  • Test pull request on Swift continuous integration.

Triggering Swift CI

The swift-ci is triggered by writing a comment on this PR addressed to the GitHub user @swift-ci. Different tests will run depending on the specific comment that you use. The currently available comments are:

Smoke Testing

Platform Comment
All supported platforms @swift-ci Please smoke test
All supported platforms @swift-ci Please smoke test and merge
OS X platform @swift-ci Please smoke test OS X platform
Linux platform @swift-ci Please smoke test Linux platform

A smoke test on macOS does the following:

  1. Builds the compiler incrementally.
  2. Builds the standard library only for macOS. Simulator standard libraries and
    device standard libraries are not built.
  3. lldb is not built.
  4. The test and validation-test targets are run only for macOS. The optimized
    version of these tests are not run.

A smoke test on Linux does the following:

  1. Builds the compiler incrementally.
  2. Builds the standard library incrementally.
  3. lldb is built incrementally.
  4. The swift test and validation-test targets are run. The optimized version of these
    tests are not run.
  5. lldb is tested.

Validation Testing

Platform Comment
All supported platforms @swift-ci Please test
All supported platforms @swift-ci Please test and merge
OS X platform @swift-ci Please test OS X platform
OS X platform @swift-ci Please benchmark
Linux platform @swift-ci Please test Linux platform

Lint Testing

Language Comment
Python @swift-ci Please Python lint

Note: Only members of the Apple organization can trigger swift-ci.

This changes the swift-demangle interactive STDIN mode to immediately
print the demangled symbol on return as opposed to printing them all at
the end.

ssize_t ReadBytes;

Buffer.reserve(Buffer.size() + ChunkSize);
ReadBytes = read(STDIN_FILENO, Buffer.end(), ChunkSize);
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm concerned about breaking a symbol across chunk boundaries. Can we do something line-oriented instead? (I don't think we care about running this tool across binary data.)

@jrose-apple
Copy link
Contributor

Thanks, Keith! Hm, is there any way to write a test for this?

@keith
Copy link
Member Author

keith commented Aug 20, 2016

Thanks for the feedback Jordan! I've pushed a getline approach and some tests, let me know what you think!

@jrose-apple
Copy link
Contributor

This implementation looks good. I think we already have tests for stdin-demangling in test/Demangle/; what I really wanted to know is if there's a way to test that it's streaming now. I can't think of a good way without building a whole wrapper script, though—which would be nice, but I wouldn't block the patch over it. I think it's okay to drop this extra test file and just move ahead.

This changes the swift-demangle interactive STDIN mode to immediately
print the demangled symbol on return as opposed to printing them all at
the end.
@keith
Copy link
Member Author

keith commented Aug 22, 2016

Ah sorry about that. I looked in that directory but assumed tests would be named after the CLI. I'll remove those here!

@keith
Copy link
Member Author

keith commented Aug 22, 2016

Updated

@jrose-apple
Copy link
Contributor

@swift-ci Please smoke test

1 similar comment
@jrose-apple
Copy link
Contributor

@swift-ci Please smoke test

@shahmishal
Copy link
Member

@swift-ci Please smoke test OS X

@jrose-apple jrose-apple merged commit 55aa909 into swiftlang:master Aug 23, 2016
@jrose-apple
Copy link
Contributor

Merged. Thanks, Keith!

@keith
Copy link
Member Author

keith commented Aug 24, 2016

Thanks! Should we close https://bugs.swift.org/browse/SR-2410 ?

@keith keith deleted the ks/swift-demangle-interactive branch August 24, 2016 01:38
@CodaFi
Copy link
Contributor

CodaFi commented Aug 24, 2016

Yes, please.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants