Apache POI - Common 5.3.0 · org.apache.poi.poifs.macros.VBAMacroReader

Modifier and Type	Class and Description
private static class	VBAMacroReader.ASCIIUnicodeStringPair
private static enum	VBAMacroReader.DIR_STATE
protected static class	VBAMacroReader.ModuleImpl
protected static class	VBAMacroReader.ModuleMap
private static enum	VBAMacroReader.RecordType

Modifier and Type	Field and Description
private static final int	DOC_STRING_RESERVED
private POIFSFileSystem	fs
private static final int	HELP_FILE_PATH_RESERVED
private static final Logger	LOGGER
private static final int	MAX_STRING_LENGTH
private static final int	MODULE_DOCSTRING_RESERVED
private static final int	PROJECT_CONSTANTS_RESERVED
private static final int	REFERENCE_NAME_RESERVED
private static final int	STREAMNAME_RESERVED
protected static final String	VBA_PROJECT_OOXML
protected static final String	VBA_PROJECT_POIFS

Access	Constructor and Description
public	VBAMacroReader(InputStream rstream)
public	VBAMacroReader(File file)
public	VBAMacroReader(POIFSFileSystem fs)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
private static byte[]	Returns: uncompressed bytes if found, `null` otherwise findCompressedStreamWBruteForce(InputStream full module inputstream to read is) Sometimes the offset record in the dirstream is incorrect, but the macro can still be found.
protected void	findMacros(DirectoryNode The directory of entries to look at dir, VBAMacroReader.ModuleMap The resulting map of modules modules) Recursively traverses directory structure rooted at `dir`.
protected void	findModuleNameMap(DirectoryNode node, Map<String, String> moduleNameMap, VBAMacroReader.ModuleMap modules)
protected void	findProjectProperties(DirectoryNode node, Map<String, String> moduleNameMap, VBAMacroReader.ModuleMap modules)
private VBAMacroReader.ModuleImpl	getModule(String moduleName, Map<String, String> moduleNameMap, VBAMacroReader.ModuleMap moduleMap)
private void	openOOXML(InputStream zipFile)
private void	processDirStream(Entry dir, VBAMacroReader.ModuleMap modules)
public Map<String, Module>	readMacroModules()
public Map<String, String>	Returns: All the macros and their contents readMacros() Reads all macros from all modules of the opened office file.
protected void	readMacros(DirectoryNode macroDir, VBAMacroReader.ModuleMap modules) Reads VBA Project modules from a VBA Project directory located at `macroDir` into `modules`.
private static String	readMBCS(int firstByte, InputStream is, Charset charset)
private static void	readModuleFromDocumentStream(DocumentNode documentNode, String name, VBAMacroReader.ModuleMap modules)
private static void	readModuleMetadataFromDirStream(RLEDecompressingInputStream the run-length encoded input stream to read from in, String the stream name of the module streamName, VBAMacroReader.ModuleMap a map to store the modules modules) reads module from DIR node in input stream and adds it to the modules map for decompression later on the second pass through this function, the module will be decompressed Side-effects: adds a new module to the module map or sets the buf field on the module to the decompressed stream contents (the VBA code for one module)
protected void	readNameMapRecords(InputStream is, Map<String, String> moduleNames, Charset charset)
protected void	readProjectProperties(DocumentInputStream dis, Map<String, String> moduleNameMap, VBAMacroReader.ModuleMap modules)
private static String	Returns: a java String in the supplied character set readString(InputStream the inputstream to read from stream, int number of bytes to read from stream length, Charset the character set encoding of the bytes in the stream charset) Read `length` bytes of MBCS (multi-byte character set) characters from the stream
private VBAMacroReader.ASCIIUnicodeStringPair	readStringPair(RLEDecompressingInputStream in, Charset charset, int reservedByte)
private VBAMacroReader.ASCIIUnicodeStringPair	readStringPair(RLEDecompressingInputStream in, Charset charset, int reservedByte, boolean throwOnUnexpectedReservedByte)
private static String	readUnicode(InputStream is)
private String	readUnicodeString(RLEDecompressingInputStream in, int unicodeNameRecordLength)
private static void	trySkip(InputStream in, long n) Skips `n` bytes in an input stream, throwing IOException if the number of bytes skipped is different than requested.
private static byte[]	tryToDecompress(InputStream is)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class VBAMacroReader

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary